Skip to content
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

[Doc] Rename 'Interactions with JanusGraph' section to 'JanusGraph Basics' #4031

Conversation

li-boxuan
Copy link
Member

@li-boxuan li-boxuan commented Oct 5, 2023

The JanusGraph Basics section was split into a few sections in v0.6, one of which was 'Interactions with JanusGraph'. This section contains 3 things: transactions, predicates, and drivers. It's hard to extract a common keyword from them, and 'interactions' is a very vague word that is not straight-forward to understand. This renames the section back to 'JanusGraph Basics', because transactions, predicates, and drivers are the necessary basic staff one has to learn about in order to use JanusGraph.


Thank you for contributing to JanusGraph!

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there an issue associated with this PR? Is it referenced in the commit message?
  • Does your PR body contain #xyz where xyz is the issue number you are trying to resolve?
  • Has your PR been rebased against the latest commit within the target branch (typically master)?
  • Is your initial contribution a single, squashed commit?

For code changes:

  • Have you written and/or updated unit tests to verify your changes?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE.txt file, including the main LICENSE.txt file in the root of this repository?
  • If applicable, have you updated the NOTICE.txt file, including the main NOTICE.txt file found in the root of this repository?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

…sics'

The JanusGraph Basics section was split into a few sections in v0.6, one of which was
'Interactions with JanusGraph'. This section contains 3 things: transactions, predicates,
and drivers. It's hard to find a common topic among them, and 'interactions' is a very vague
word that is not straight-forward to understand. This renames the section back to 'JanusGraph
Basics', because transactions, predicates, and drivers are the necessary basic staff one has
to learn about in order to use JanusGraph.

Signed-off-by: Boxuan Li <[email protected]>
@li-boxuan li-boxuan requested review from farodin91 and a team October 5, 2023 07:23
@janusgraph-bot janusgraph-bot added the cla: external Externally-managed CLA label Oct 5, 2023
@li-boxuan li-boxuan merged commit 41f727d into JanusGraph:master Oct 9, 2023
176 checks passed
@li-boxuan li-boxuan deleted the doc/rename-interactions-with-janusgraph branch October 9, 2023 01:05
@li-boxuan li-boxuan added this to the Release v1.0.0 milestone Oct 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs cla: external Externally-managed CLA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants