Skip to content

Commit eed7f24

Browse files
authoredJun 11, 2022
Version 6.0 Release (#483)
* Update docs for #466 * Upgrade to use node 18 for CI * Upgrade Docusaurus * Added README for docs development and versioning * Versioned docs for 6.0 release
1 parent 8078bc2 commit eed7f24

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+7818
-20
lines changed
 

‎.github/workflows/doc_generation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
- name: "Setup NodeJS"
2525
uses: actions/setup-node@v3
2626
with:
27-
node-version: '14.x'
27+
node-version: '18.x'
2828

2929
- name: "Yarn install"
3030
run: yarn install

‎website/README

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# GraphQLite Website
2+
3+
The GraphQLite website is primarily a documentation site for GraphQLite. It's built on the Docusaurus framework, and is hosted on [GitHub](https://graphqlite.thecodingmachine.io/).
4+
5+
More details on using Docusaurus can be found in the [official documentation](https://docusaurus.io/docs/docs-introduction).
6+
7+
*This documentation could use further updating.*
8+
9+
## Developing and Testing
10+
11+
All code changes, aside from errors in previous documentation, should be done in the `docs` directory. The `package.json` file outlines available commands you can use for starting the server, building the docs, etc.
12+
13+
- `npm run build` *(Transpiles/builds `docs` into `build` directory)*
14+
- `npm run start` *(Starts the local npm server)*
15+
16+
## Versioning
17+
18+
Firstly, doc versions are cached in the `versioned_docs` directory. Meanwhile, the "Next" version, as represented on the website, is the current `master` branch of the `docs` dir. A list of the versions available is actually managed by the `versions.json` file, regardless of the `versioned_docs` directory.
19+
20+
The [versioning section of the Docusaurus documentation](https://docusaurus.io/docs/versioning) covers this is more detail, but the following is related to our specific implementation:
21+
22+
### Steps to Create and Deploy a new Version
23+
24+
*All command paths are relative to the `website` directory. Ensure that you have `./node_modules/.bin` added to your path.*
25+
26+
1. Firstly, we need to tag a new version, which will cache a copy of the documentation in the `versioned_docs` directory, update the `versioned_sidebars`, and update the `versions.json` file.
27+
28+
```bash
29+
$ docusaurus docs:version 1.1
30+
```
31+
*Be sure to include the X.X in the version, not just X.*
32+
2. Technically, you're done, just commit these changes and the CI workflow will deploy when merged into `master`.

0 commit comments

Comments
 (0)