[DOC] Create a glossary to explain all the concepts #1275
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
♻️ PR Preview 4c4721b has been successfully destroyed since this PR has been closed.
🤖 By surge-preview |
csouchet
force-pushed
the
1272-create_glossary
branch
3 times, most recently
from
ea4a5bc to
642441a
Compare
csouchet
force-pushed
the
1272-create_glossary
branch
from
642441a to
074be92
Compare
aibcmars
approved these changes
May 2, 2021
aibcmars
reviewed
May 5, 2021
aibcmars
reviewed
May 5, 2021
aibcmars
reviewed
May 5, 2021
Co-authored-by: Marcin Michniewicz <45601541+aibcmars@users.noreply.github.com>
aibcmars
reviewed
May 6, 2021
aibcmars
reviewed
May 6, 2021
csouchet
commented
May 7, 2021
Co-authored-by: Marcin Michniewicz <45601541+aibcmars@users.noreply.github.com>
tbouffard
reviewed
May 7, 2021
docs/users/index.adoc
Outdated
| @@ -30,3 +30,5 @@ include::bpmn-support.adoc[] | |||
|
|
|||
| include::architecture/00-index.adoc[] | |||
|
|
|||
| include::glossary.adoc[] | |||
There was a problem hiding this comment.
I would put this before the bpmn-support.
The bpmn-support paragraph is the 1st one that provides details about the lib. Glossary is general paragraph that reminds all import concepts that we use in the lib.
There was a problem hiding this comment.
as discussed, we may also add links to the glossary in the rest of the user documentation
tbouffard
reviewed
May 7, 2021
Put it right after usage, prior introducing more details about the features
11 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1272