-
Notifications
You must be signed in to change notification settings - Fork 64
Update README to include documenting changes to language and GQL #1100
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 4 commits
549a17c
65e661f
331fd67
25199e2
aaa92c0
86703f1
d196b07
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,14 @@ | ||
| = Neo4j Cypher Manual | ||
|
|
||
| This page covers the following topics: | ||
|
|
||
| * xref:README.adoc#build-locally[] | ||
| * xref:README.adoc#raise-prs[] | ||
| * xref:README.adoc#documenting-changes[] | ||
| * xref:README.adoc#cypher-gql[] | ||
|
|
||
|
|
||
| [[build-locally]] | ||
| == Building locally | ||
|
|
||
| === Prereqs | ||
|
|
@@ -39,7 +48,7 @@ When you run `npm start`, the project is monitored for updates to asciidoc files | |
|
|
||
| If a change to an asciidoc file is detected, the site is automatically rebuilt. | ||
|
|
||
|
|
||
| [[raise-prs]] | ||
| == Raising PRs | ||
|
|
||
|
|
||
|
|
@@ -68,3 +77,39 @@ There are a few edge cases where we might want to work only on the current branc | |
| ** Create a feature branch from `dev`, to be merged into `dev` when appropriate. | ||
| * When a new version is ready to published, the `5.x` branch will get a git tag, named with the exact version (for example, **5.1.0**), signifying that this point-in-time marks the completion of the work for that minor release. | ||
| * Updates merged into the `dev` branch for the next release are cherry-picked into the `5.x` branch. | ||
|
|
||
| [[documenting-changes]] | ||
| == Documenting changes to Cypher | ||
|
|
||
| New, updated, deprecated, and removed features must be recorded on the xref:deprecations-additions-removals-compatibility.adoc[] page. | ||
|
|
||
| New and deprecated features should also be marked with a label: | ||
|
|
||
| * If the impacted feature has its own header in the Cypher Manual, use the following: | ||
|
|
||
| [role=label--new-5.x] | ||
| \== Header | ||
|
||
|
|
||
| [role=label--deprecated] | ||
| \== Header | ||
|
||
|
|
||
| * If the impacted feature is documented within a table (such as a return column in a `SHOW` command), use the following: | ||
|
|
||
| `featureX` label:new[Introduced in 5.x] + | ||
| `featureY` label:deprecated[] | ||
|
Comment on lines
+102
to
+103
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. these work, but i guess they could use a source block as well |
||
|
|
||
| Labels can be difficult to apply to updated features. | ||
| In these cases, it is often preferable to note the change in a sentence. | ||
| For example: "As of Neo4j 5.x, featureX supports ..." | ||
|
|
||
| Removed features should be removed from the Cypher Manual. | ||
|
||
|
|
||
| [[cypher-gql]] | ||
| == Cypher and GQL | ||
|
|
||
| When documenting a new Cypher feature, its relationship with GQL must be considered: | ||
|
|
||
| * If the feature is part of GQL's mandatory features, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/supported-mandatory.adoc[]. | ||
| * If the feature is part of GQL's optional features, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/supported-optional.adoc[]. | ||
| * if the feature adds functionality for which there exists an analogous GQL equivalent, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/analogous-cypher.adoc[]. | ||
|
||
| * If the feature adds functionality for which there exists no GQL equivalent, it should be recorded on the page xref:modules/ROOT/pages/appendix/gql-conformance/additional-cypher.adoc[]. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure these have to be set
asciidoc generates anchors for headings by default - it should be
#building-locallyfor the line belowedit: just noticed, on github, both anchors are present now (eg https://github.com/JPryce-Aklundh/docs-cypher/tree/updated_readme?tab=readme-ov-file#documenting-changes and https://github.com/JPryce-Aklundh/docs-cypher/tree/updated_readme?tab=readme-ov-file#documenting-changes-to-cypher)