Remove Administration pages + Keyword Glossary page #766
Conversation
|
Thanks for the documentation updates. The preview documentation has now been torn down - reopening this PR will republish it. |
renetapopova
left a comment
renetapopova
left a comment
There was a problem hiding this comment.
Thanks, @JPryce-Aklundh. This is huge! I fixed two broken links that were logged locally, but I couldn't verify the rest of the links. I think it is OK to merge it and verify later.
AlexicaWright
left a comment
AlexicaWright
left a comment
There was a problem hiding this comment.
Just a few comments on the format of the links in the table. Tremendous job repointing all of those links!
| The pages previously in this chapter have been moved to the link:{neo4j-docs-base-uri}/operations-manual/{page-version}/[Operations Manual]. | ||
|
|
||
| More information about each of these topics can be found in the following sections: | ||
| More specific information about the content relocation is listed in the table below: |
There was a problem hiding this comment.
| More specific information about the content relocation is listed in the table below: | |
| More specific information about the content relocation is listed in the table: |
| Repeated pattern. | ||
| Related to the command part immediately before this is repeated. | ||
| | A comma separated list of names would be `+name[, ...]+`. | ||
| | Server management | link:{neo4j-docs-base-uri}/operations-manual/{page-version}/clustering/[Clustering] |
There was a problem hiding this comment.
| | Server management | link:{neo4j-docs-base-uri}/operations-manual/{page-version}/clustering/[Clustering] | |
| | Server management | link:{neo4j-docs-base-uri}/operations-manual/{page-version}/clustering/servers[Managing servers in a cluster] |
There was a problem hiding this comment.
As above, rather than saying Clustering -> Managing servers in a cluster I think it's better and more conventional to just use the title of the sub-chapter.
| | Used to indicate an optional part of the command. | ||
| It also groups alternatives together, when there can be either of the alternatives or nothing. | ||
| | If a keyword in the syntax can either be in singular or plural, we can indicate that the `S` is optional with `GRAPH[S]`. | ||
| | Alias management | link:{neo4j-docs-base-uri}/operations-manual/{page-version}/database-administration/aliases/manage-aliases-standard-databases/[Database administration -> Managing aliases] |
There was a problem hiding this comment.
We normally reserve the arrow for pointing from a different manual to a chapter/section, like "Operations Manual -> Database administration". This is a tricky situation as we've omitted the name of the manual. Elsewhere, we don't mention the name of the chapter if we're linking to a sub-chapter. So I'd be inclined to say just Managing aliases here. See my next comment also.
The Database administration pages have now been migrated to the Operations Manual. This PR deletes the pages in the Cypher Manual, leaving only the administration/index.adoc where a note is posted about content relocation. This PR also deletes the keyword glossary page, which was not maintained and is just a poor substitute for the cheat cheet. --------- Co-authored-by: Reneta Popova <reneta.popova@neo4j.com>
Includes the following PRs: - #676 - #687 - #688 - #722 - #726 - #734 - #735 - #737 - #748 - #749 - #752 - #766 --------- Co-authored-by: Gem Lamont <106068376+gem-neo4j@users.noreply.github.com> Co-authored-by: Nils Ceberg <nils.ceberg@neo4j.com> Co-authored-by: Matthew Parnell <matthew.parnell@neo4j.com> Co-authored-by: Matthew Parnell <matt@parnmatt.co.uk> Co-authored-by: Reneta Popova <reneta.popova@neo4j.com> Co-authored-by: Lasse Heemann <lasse.heemann@neo4j.com> Co-authored-by: Ali Ince <ali-ince@users.noreply.github.com> Co-authored-by: Therese Magnusson <scout.therese@gmail.com> Co-authored-by: Stefano Ottolenghi <stefano.ottolenghi@neo4j.com> Co-authored-by: Therese Magnusson <therese.magnusson@neotechnology.com> Co-authored-by: linneaandersson <Linneamaria10@gmail.com>
4 participants
The Database administration pages have now been migrated to the Operations Manual.
This PR deletes the pages in the Cypher Manual, leaving only the administration/index.adoc where a note is posted about content relocation.
This PR also deletes the keyword glossary page, which was not maintained and is just a poor substitute for the cheat cheet.