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

docs: improve vm install instructions #3091

Merged
merged 2 commits into from
Nov 28, 2022

Conversation

ossdhaval
Copy link
Contributor

Prepare


Description

Enhance VM install docs by adding details below:

  • Use a specific version number in the package download instead of getting the latest release dynamically
  • add instructions to verify packages after download using sha256sum

Target issue

closes #issue-number-here

Implementation Details


Test and Document the changes

  • Static code analysis has been run locally and issues have been fixed
  • Relevant unit and integration tests have been added/updated
  • Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

@ossdhaval ossdhaval self-assigned this Nov 28, 2022
@mo-auto mo-auto merged commit 40acfb4 into main Nov 28, 2022
@mo-auto mo-auto deleted the doc-improve-vm-install-instructions branch November 28, 2022 08:12
@mo-auto mo-auto added the area-documentation Documentation needs to change as part of issue or PR label Nov 28, 2022
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
Labels
area-documentation Documentation needs to change as part of issue or PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants