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

WIP: Versioned docs #17905

Closed
wants to merge 11 commits into from
Closed

WIP: Versioned docs #17905

wants to merge 11 commits into from

Conversation

lunny
Copy link
Member

@lunny lunny commented Dec 4, 2021

No description provided.

@lunny lunny changed the title ersioned docs WIP: Versioned docs Dec 4, 2021
@codecov-commenter
Copy link

codecov-commenter commented Dec 4, 2021

Codecov Report

❗ No coverage uploaded for pull request base (main@e5c6c00). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main   #17905   +/-   ##
=======================================
  Coverage        ?   47.39%           
=======================================
  Files           ?      952           
  Lines           ?   132524           
  Branches        ?        0           
=======================================
  Hits            ?    62807           
  Misses          ?    62145           
  Partials        ?     7572           

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 e5c6c00...783f865. Read the comment docs.

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Dec 4, 2021
Makefile Outdated
cd docs; make trans-copy clean build-offline;
cd docs; make trans-copy clean ;
#git co release/v1.13 && PUBLIC=public/v1.13 make build-offline ;
git co release/v1.14 && PUBLIC=public/v1.14 make build-offline ;
Copy link
Member

Choose a reason for hiding this comment

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

Can we avoid having to hardcode the release branch? Maybe some logic that builds all branches, back to a certain starting branch?

@wxiaoguang
Copy link
Contributor

Some more users are misled by documents recently, they are asking about why they do not have the registry feature.

@silverwind
Copy link
Member

silverwind commented Apr 8, 2022

I think the final solution for docs will be docusaurus, which has support for versioning, like woodpecker-ci has :)

@wxiaoguang
Copy link
Contributor

wxiaoguang commented Apr 8, 2022

Done is better than perfect, as long as it can continue to improve without difficulty.

If we can use a simple mechanism to split the documents for versions (months ago), then there will be no user asking about strange questions any more, and there is still a chance to improve the versioned document system.

Today there is one more user asking about why he doesn't have package feature in discord.

@silverwind
Copy link
Member

Yeah, I'm not opposed to having some intermediate solution now, just pointing out potential better solutions for the future :)

@wxiaoguang
Copy link
Contributor

Today one more

@wxiaoguang
Copy link
Contributor

@lunny lunny closed this Oct 19, 2022
@lunny lunny deleted the lunny/versioned_docs branch October 19, 2022 08:31
@go-gitea go-gitea locked and limited conversation to collaborators May 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants