docs: formatting and proofreading of install docs #3092
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
mo-auto
approved these changes
Nov 28, 2022
mo-auto
added
the
area-documentation
jgomer2001
pushed a commit
that referenced
this pull request
Nov 28, 2022
* docs: docker installation (#3027) * docs: docker installation * docs: add quick-start page * docs: readme.md and compose,md made identical * docs: adjust warning as per github pages syntex * docs: replace docker with docker compose * docs: github page identical to compose page * docs: remove yml file deletion * docs: fix * docs: fix helm chart url * build(deps): bump zeebe-io/backport-action from 0.0.8 to 0.0.9 (#3060) Bumps [zeebe-io/backport-action](https://github.com/zeebe-io/backport-action) from 0.0.8 to 0.0.9. - [Release notes](https://github.com/zeebe-io/backport-action/releases) - [Commits](korthout/backport-action@v0.0.8...v0.0.9) --- updated-dependencies: - dependency-name: zeebe-io/backport-action dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * docs: improve vm install instructions (#3091) * docs: add sha check instructions for rhel * docs: add sha check instructions for suse * docs: formating and proofreading of install docs (#3092) * feat: add custom annotation for configuration property and feature flag documentation (#2852) * feat: add custom annotation for prop documentation * feat: add annotation processor * feat: annotate properties * feat: configure annotation processor * feat: add default value * feat: add annotation to enum * feat: add comment * feat: rename annotation * feat: rename processor class * feat: refactor to new core module * feat: fix test class errors * feat: rename the module * feat: add table and details view of content * feat: sort properties * feat: change wording - mandatory to required * feat: add exception handling and logging * feat: write file under classes output dir * feat: create output file under target directory * feat: rename property and file * feat: create separate annotation for feature flags * feat: code cleanup * fix: add description to properties * fix: add property descriptions from Gluu docs * fix: add descriptions from Swagger * fix(fido2): annotate fido config properties * feat(scim): configure property documentation annotations * fix: add module name to file and title * fix: add Feature Flag descriptions * fix: integrate doc generation with CI * fix: add tags to generated docs * fix: create separate sections for properties and flags * fix: update the artifact version for jans-doc * fix: contents of markdown files after merge * ci: remove token req * fix: sonar issues * fix: sonar issues * fix: sonar issues * fix: move doc generation to shell script Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com> * ci: use hotspath-storage in quickstart script * doc: remove redundant API details sections (#3093) * feat(jans-auth-server): specify minimum acr for clients #343 (#3083) * feat(jans-auth-server): specify minimum acr for clients #343 * feat(jans-auth-server): added minimum acr properties to dynamic registration #343 * doc(jans-auth-server): added docs and updated swagger with new minimum acr related properties #343 * docs: add kuberentes planning guide initial points * docs: add kuberentes planning guide initial points * Update certificates.md (#3096) * docs: scim logs Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Amro Misbah <amromisba7@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Dhaval D <343411+ossdhaval@users.noreply.github.com> Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com> Co-authored-by: YuriyZ <yzabrovarniy@gmail.com> Co-authored-by: mzico <mohib@gluu.org>
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.
Prepare
Description
Fix formatting issues in install docs.
Target issue
closes #issue-number-here
Implementation Details
Test and Document the changes