Skip to content

Support versioning for documentation #5588

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

Closed
6 tasks
adelowo opened this issue Dec 23, 2018 · 6 comments
Closed
6 tasks

Support versioning for documentation #5588

adelowo opened this issue Dec 23, 2018 · 6 comments
Labels
issue/confirmed Issue has been reviewed and confirmed to be present or accepted to be implemented type/docs This PR mainly updates/creates documentation

Comments

@adelowo
Copy link
Member

adelowo commented Dec 23, 2018

  • Gitea version (or commit ref): not relevant
  • Git version: not relevant
  • Operating system: not relevant
  • Database (use [x]):
    • PostgreSQL
    • MySQL
    • MSSQL
    • SQLite
  • Can you reproduce the bug at https://try.gitea.io:
    • Yes (provide example URL)
    • No
    • [ x] Not relevant
  • Log gist:

Description

I expect to be able to view docs for v1.6,v1.5 and master's. This has bitten me a few times,
the most recent being the lets encrypt integration. I think by the time it was available on the docs,
1.6 wasn't released yet but I went to tweak the config thinking how I missed that part of the docs earlier - I think I was running 1.5.3 in production then.

Another one that comes to mind is #5376 (comment)

So ideally, we'd have something like https://docs.gitea.io/en-us/master and https://docs.gitea.io/en-us/${version}

https://docs.gitea.io/en-us/ can start redirecting to https://docs.gitea.io/en-us/master

@adelowo adelowo changed the title Documentation for a released version Separate versioning for documentation Dec 23, 2018
@adelowo adelowo changed the title Separate versioning for documentation Support versioning for documentation Dec 23, 2018
@techknowlogick techknowlogick added the type/docs This PR mainly updates/creates documentation label Jan 1, 2019
@bmackinney
Copy link

bmackinney commented Jan 27, 2019

This could be fairly straightforward if the team is willing/interested in offloading docs hosting to www.netlify.com. I'm willing/able to do the work - I think it requires:

  • create netlify.toml and configure deployments
  • create branches if necessary for subdomains. release/v1.7.docs.gitea.io may not work.
  • modify layouts to indicate current branch, link to other versions.

@techknowlogick
Copy link
Member

Documentation is already on netlify

@bmackinney
Copy link

I see that now

  • update docs/README.md

@stale
Copy link

stale bot commented Apr 14, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs during the next 2 weeks. Thank you for your contributions.

@stale stale bot added the issue/stale label Apr 14, 2019
@lunny lunny added the issue/confirmed Issue has been reviewed and confirmed to be present or accepted to be implemented label Apr 15, 2019
@stale stale bot removed the issue/stale label Apr 15, 2019
@wxiaoguang
Copy link
Contributor

FYI, there are some works, but no progress.

@lunny
Copy link
Member

lunny commented Mar 26, 2023

Fixed by https://gitea.com/gitea/gitea-docusaurus
New documentation site is https://docs.gitea.com and there is a blog PR https://gitea.com/gitea/blog/pulls/247

@lunny lunny closed this as completed Mar 26, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
issue/confirmed Issue has been reviewed and confirmed to be present or accepted to be implemented type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

No branches or pull requests

5 participants