Issue 2479 - Update installation documentation #2520
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
|
I think we should explicitly document the best way to use a released version, i.e. run sleeper builder, then git clone the repo, then checkout the desired version, then run buildForTest, etc. |
gaffer01
reviewed
May 16, 2024
docs/01-getting-started.md
Outdated
| You can also specify a version to install. This can be `main` for the latest nightly build, or a release in the | ||
| format `v0.20.0`. These correspond to a branch or tag in the GitHub repository. You can find a list of released | ||
| versions [here](https://github.com/gchq/sleeper/tags), and the change log [here](../CHANGELOG.md). | ||
| This will install the latest development version. This is an untested version and may not work. When ready this is |
There was a problem hiding this comment.
Replace "This is an untested version and may not work." with "The latest development version will not have been as fully tested as released versions and may not work as expected. Most users should use the latest released version - see [here](../CHANGELOG.md."
gaffer01
approved these changes
May 16, 2024
kr565370
approved these changes
May 16, 2024
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.
Make sure you have checked all steps below.
Issue
PR"
Tests
Documentation
separate issue for that below.
NOTICES file to reflect this.