docs: [Breaking] split the docs into smaller pages #6079
Conversation
# Conflicts: # wiki/content/clients/index.md # wiki/content/deploy/index.md # wiki/content/enterprise-features/index.md # wiki/content/mutations/index.md
NamanJain8
requested review from
danielmai,
manishrjain,
MichaelJCompton and
vvbalaji-dgraph
as code owners
|
|
There was a problem hiding this comment.
Reviewed 1 of 127 files at r3, 1 of 6 files at r4.
Reviewable status: 2 of 131 files reviewed, 5 unresolved discussions (waiting on @danielmai, @manishrjain, @MichaelJCompton, @NamanJain8, and @vvbalaji-dgraph)
wiki/scripts/build.sh, line 14 at r5 (raw file):
0.0.0.0:8000}"
Was this changed for a reason?
wiki/scripts/build.sh, line 21 at r5 (raw file):
OLD_THEME="master" NEW_THEME="naman/docs-merge"
Is the plan to swap this once the docs-merge branch actually merged?
wiki/scripts/build.sh, line 32 at r5 (raw file):
'namandocs'
What is namandocs? Is this branch going to be used moving forward, or was it just for testing?
wiki/scripts/build.sh, line 45 at r5 (raw file):
'v20.03.1'
What's the difference between VERSIONS_ARRAY and OLD_VERSIONS?
I feel that OLD_VERSIONS should also have v20.03.3 and v20.03.4 if OLD_VERSIONS means it's not using the new split-page docs structure.
wiki/themes/hugo-docs, line 1 at r5 (raw file):
Subproject commit d06adcee33319b295238861de2123982b7e79cf0
Can you remove this submodule? If we do need this, then we need to update the wiki README. Otherwise, we can continue with the current approach of not having the hugo-docs theme as a git submodule.
…ons (#56) * Changes to theme to suit breaking large content sections see (hypermodeinc/dgraph#6079) * Remove defunct JavaScript and switch variables used * Tweak side menus and JavaScript * Add JavaScript redirect Co-authored-by: Naman Jain <naman@dgraph.io>
There was a problem hiding this comment.
Reviewed 2 of 130 files at r2, 121 of 127 files at r3, 4 of 6 files at r4, 1 of 1 files at r5, 3 of 3 files at r6.
Reviewable status: all files reviewed, 5 unresolved discussions (waiting on @manishrjain, @MichaelJCompton, @NamanJain8, and @vvbalaji-dgraph)
…nt sections (#56)" The new theme doesn't work with the current versions of the docs. Once hypermodeinc/dgraph#6079 is merged, this change can be brought back. This reverts commit 913be2e.
…nt sections (#56)" (#61) The new theme doesn't work with the current versions of the docs. Once hypermodeinc/dgraph#6079 is merged, this change can be brought back. This reverts commit 913be2e.
NamanJain8
changed the title
This PR splits docs with larger pages into smaller ones. Splitting work is from https://github.com/ChrisChinchilla/dgraph. This PR updates the build script of docs to serve docs via new hugo-theme and also add redirects as split pages don't exist in old versions. Old versions should use "old" theme of "dgraph-io/hugo-docs" while newer branches should use its master.
This PR splits docs with larger pages into smaller ones.
Splitting work is from https://github.com/ChrisChinchilla/dgraph.
This PR updates the build script of docs to serve docs via new hugo-theme.
This change is
Docs Preview: