More version configs for docs #10597
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
jolheiser
added
type/docs
jolheiser
commented
Mar 4, 2020
Comment on lines
-43
to
+44
| recommended to install the version of go that our continuous integration is | ||
| running. At the time of writing this is Go version 1.12; however, this can be | ||
| checked by looking at the | ||
| [master `.drone.yml`](https://github.com/go-gitea/gitea/blob/master/.drone.yml) | ||
| (At the time of writing | ||
| [line 67](https://github.com/go-gitea/gitea/blob/8917d66571a95f3da232a0c27bc1300210d10fde/.drone.yml#L67) | ||
| is the relevant line - but this may change.) | ||
| recommended to install the version of Go that our continuous integration is | ||
| running. As of last update, it should be Go version {{< go-version >}}. |
There was a problem hiding this comment.
Feel free to have me re-write this. I found it to be slightly confusing, though, as it said 1.12 then perma-links to a line saying 1.11, and the line for master is already off because of drone changes.
GiteaBot
added
the
lgtm/need 2
Codecov Report
@@ Coverage Diff @@
## master #10597 +/- ##
==========================================
+ Coverage 43.7% 43.71% +<.01%
==========================================
Files 585 585
Lines 82031 82031
==========================================
+ Hits 35852 35857 +5
+ Misses 41737 41733 -4
+ Partials 4442 4441 -1
Continue to review full report at Codecov.
|
6543
approved these changes
Mar 4, 2020
GiteaBot
added
lgtm/need 1
zeripath
approved these changes
Mar 4, 2020
GiteaBot
added
lgtm/done
|
Ping LG-TM |
Merged
|
Same could be done for Node.js version as well. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR may need an update depending on whether it gets merged before or after #10467
While they aren't used too often in the docs, it would be better to abstract them sooner than later imo
It adds two more config variables and subsequent shortcodes to the docs,
minGoVersionandgoVersion.Perhaps
currGoVersionorcurrentGoVersionmakes more sense for the latter?As well, some spots had a full semver like
1.11.0while others simply had1.11. I opted for the latter as that's easier to maintain (rather than updating the docs for every go version) and probably enough information.On a semi-related note, it may not be a bad idea to refer people to the docs from places like the README, so there are fewer places to remember to swap out versions.