Skip to content

Commit 051f340

Browse files
authored
Update siteconifg for docs site (ExpediaGroup#402)
* Update siteconifg for docs site Update the docs site config and update some build settings. Adding an action to auto-publish next * Update to npm so we don't have to install yarn
1 parent 526a845 commit 051f340

File tree

8 files changed

+1656
-1631
lines changed

8 files changed

+1656
-1631
lines changed

.gitignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
*.iml
2-
.idea
2+
.idea/
33
.DS_Store
4-
target
4+
target/
55
pom.xml.versionsBackup
66

77
website/translated_docs
88
website/build/
9-
website/yarn.lock
109
website/node_modules
1110
website/i18n/*

docs/doc-main.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
---
2-
id: doc-main
3-
title: GraphQL-Kotlin User Guide
4-
---
5-
6-
GraphQL Kotlin consists of number of libraries that aim to simplify GraphQL integration for Kotlin applications.
7-
8-
## 📦 Modules
9-
10-
* [graphql-kotlin-federation](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-federation)
11-
— Schema generator extension to build federated GraphQL schemas
12-
* [graphql-kotlin-schema-generator](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-schema-generator)
13-
— Code only GraphQL schema generation for Kotlin
14-
* [graphql-kotlin-spring-server](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-spring-server)
15-
— Spring Boot auto-configuration library to create GraphQL web app
16-
* [examples](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples)
17-
— Example apps that use graphql-kotlin libraries to test and demonstrate usages
18-
19-
If you encounter any problems using this library please open up a new
20-
[Issue](https://github.com/ExpediaGroup/graphql-kotlin/issues)
21-
22-
Additional resources
23-
24-
* [GraphQL](https://graphql.org/)
25-
* [graphql-java](https://www.graphql-java.com/documentation/)
1+
---
2+
id: doc-main
3+
title: GraphQL Kotlin User Guide
4+
---
5+
6+
GraphQL Kotlin consists of number of libraries that aim to simplify GraphQL integration for Kotlin applications.
7+
8+
## 📦 Modules
9+
10+
* [graphql-kotlin-federation](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-federation)
11+
— Schema generator extension to build federated GraphQL schemas
12+
* [graphql-kotlin-schema-generator](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-schema-generator)
13+
— Code only GraphQL schema generation for Kotlin
14+
* [graphql-kotlin-spring-server](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/graphql-kotlin-spring-server)
15+
— Spring Boot auto-configuration library to create GraphQL web app
16+
* [examples](https://github.com/ExpediaGroup/graphql-kotlin/tree/master/examples)
17+
— Example apps that use graphql-kotlin libraries to test and demonstrate usages
18+
19+
If you encounter any problems using this library please open up a new
20+
[Issue](https://github.com/ExpediaGroup/graphql-kotlin/issues)
21+
22+
Additional resources
23+
24+
* [GraphQL](https://graphql.org/)
25+
* [graphql-java](https://www.graphql-java.com/documentation/)

website/.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
stable

website/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,19 @@ doing in our docs, and with content removed when it's things we dont want people
1616

1717
# Get Started in 5 Minutes
1818

19-
1. Make sure all the dependencies for the website are installed:
19+
- Make sure all the dependencies for the website are installed:
2020

2121
```sh
22+
# Install the correct version of Node/NPM with NVM
23+
nvm install
24+
2225
# Install dependencies
23-
$ yarn
26+
npm install
2427
```
25-
2. Run your dev server:
28+
- Run your dev server:
2629

2730
```sh
28-
# Start the site
29-
$ yarn start
31+
npm start
3032
```
3133

3234
## Directory Structure

website/package-lock.json

Lines changed: 1605 additions & 1585 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

website/package.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
{
2+
"name": "graphql-kotlin-docs",
3+
"license": "Apache-2.0",
4+
"engines": {
5+
"node": "12",
6+
"npm": "6"
7+
},
28
"scripts": {
39
"examples": "docusaurus-examples",
410
"start": "docusaurus-start",
@@ -9,6 +15,6 @@
915
"rename-version": "docusaurus-rename-version"
1016
},
1117
"devDependencies": {
12-
"docusaurus": "^1.13.0"
18+
"docusaurus": "1.13.0"
1319
}
1420
}

website/sidebars.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"docs": {
3-
"GraphQL-Kotlin": [
3+
"GraphQL Kotlin": [
44
"doc-main",
55
"getting-started",
66
{
@@ -64,4 +64,4 @@
6464
}
6565
]
6666
}
67-
}
67+
}

website/siteConfig.js

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,13 @@
99
// site configuration options.
1010

1111
const siteConfig = {
12-
title: 'graphql-kotlin User Documentation', // Title for your website.
13-
tagline: 'Simplifying GraphQL integration for Kotlin applications',
12+
title: 'GraphQL Kotlin', // Title for your website.
13+
tagline: 'Libraries for running a GraphQL server in Kotlin',
1414

15-
// temporarily publishing at EXPErdelfavero for development purposes. Will publish at ExpediaGroup when ready.
16-
// url: 'https://ExpediaGroup.github.io',
17-
url: 'https://Experdelfavero.github.io', // Your website URL
18-
baseUrl: '/graphql-kotlin/', // Base URL for your project */
15+
url: 'https://expediagroup.github.io', // Your website URL
16+
baseUrl: '/graphql-kotlin/', // Base URL for your project
1917
projectName: 'graphql-kotlin',
20-
// organizationName: 'ExpediaGroup',
21-
organizationName: 'Experdelfavero',
18+
organizationName: 'ExpediaGroup',
2219

2320
// For no header links in the top nav bar -> headerLinks: [],
2421
headerLinks: [
@@ -40,7 +37,7 @@ const siteConfig = {
4037
},
4138

4239
// This copyright info is used in /core/Footer.js and blog RSS/Atom feeds.
43-
copyright: `Copyright © ${new Date().getFullYear()} Expedia Inc.`,
40+
copyright: `Copyright © ${new Date().getFullYear()} Expedia, Inc.`,
4441

4542
highlight: {
4643
// Highlight.js theme to use for syntax highlighting in code blocks.
@@ -74,4 +71,4 @@ const siteConfig = {
7471
repoUrl: 'https://github.com/ExpediaGroup/graphql-kotlin',
7572
};
7673

77-
module.exports = siteConfig;
74+
module.exports = siteConfig;

0 commit comments

Comments
 (0)