Skip to content

Add note about which version embedded tool is implemented #10255

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

Merged
merged 2 commits into from
Feb 12, 2020

Conversation

techknowlogick
Copy link
Member

as title

@techknowlogick techknowlogick added the type/docs This PR mainly updates/creates documentation label Feb 12, 2020
Copy link
Member

@jolheiser jolheiser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nit, otherwise LGTM

@GiteaBot GiteaBot added the lgtm/need 1 This PR needs approval from one additional maintainer to be merged. label Feb 12, 2020
@techknowlogick techknowlogick added the skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. label Feb 12, 2020
@techknowlogick techknowlogick added this to the 1.12.0 milestone Feb 12, 2020
@codecov-io
Copy link

Codecov Report

Merging #10255 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #10255      +/-   ##
==========================================
- Coverage   43.58%   43.57%   -0.01%     
==========================================
  Files         583      583              
  Lines       80266    80266              
==========================================
- Hits        34980    34975       -5     
- Misses      40951    40956       +5     
  Partials     4335     4335
Impacted Files Coverage Δ
services/pull/check.go 33.53% <0%> (-4.88%) ⬇️
models/error.go 30.4% <0%> (-0.55%) ⬇️
models/gpg_key.go 55.37% <0%> (+0.55%) ⬆️
modules/indexer/stats/db.go 59.37% <0%> (+9.37%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3d69bbd...50fbcee. Read the comment docs.

Copy link
Member

@guillep2k guillep2k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a difficult choice since "is included in versions 1.12 and above" implies that those versions are already released (our downloads page doesn't have an 1.12 folder). I thought about this when I wrote the docs for that and for other features.

I understand that we can't start adding "when released" everywhere, because that becomes obsolete easily. One possible solution for this is having different repositories for code and docs, so docs can follow its own release/backport pattern.

As for this case in particular, this message is good enough.

@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Feb 12, 2020
@techknowlogick techknowlogick merged commit 7791d90 into go-gitea:master Feb 12, 2020
@techknowlogick techknowlogick deleted the techknowlogick-patch-3 branch February 12, 2020 19:30
@techknowlogick
Copy link
Member Author

@guillep2k sadly we've tried separate repo for docs before, and it caused no docs to be added at all.

@guillep2k
Copy link
Member

Other possible ways out of this conundrum:

  • Have some kind of dynamic setting in Hugo to {{if}} out comments that are not applicable.
  • Don't use master as a directory in the downloads page, but 1.12-development instead.

@go-gitea go-gitea locked and limited conversation to collaborators Nov 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants