Support versioning for documentation #2684

Closed
opened 2025-11-02 04:44:25 -06:00 by GiteaMirror · 6 comments
Owner

Originally created by @adelowo on GitHub (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 https://github.com/go-gitea/gitea/issues/5376#issuecomment-441181799

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

Originally created by @adelowo on GitHub (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 https://github.com/go-gitea/gitea/issues/5376#issuecomment-441181799 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
GiteaMirror added the issue/confirmedtype/docs labels 2025-11-02 04:44:25 -06:00
Author
Owner

@bmackinney commented on GitHub (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.
@bmackinney commented on GitHub (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: - [x] 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.
Author
Owner

@techknowlogick commented on GitHub (Jan 27, 2019):

Documentation is already on netlify

@techknowlogick commented on GitHub (Jan 27, 2019): Documentation is already on netlify
Author
Owner

@bmackinney commented on GitHub (Jan 27, 2019):

I see that now

  • update docs/README.md
@bmackinney commented on GitHub (Jan 27, 2019): I see that now - [ ] update `docs/README.md`
Author
Owner

@stale[bot] commented on GitHub (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[bot] commented on GitHub (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.
Author
Owner

@wxiaoguang commented on GitHub (Apr 5, 2022):

FYI, there are some works, but no progress.

@wxiaoguang commented on GitHub (Apr 5, 2022): FYI, there are some works, but no progress. * https://github.com/go-gitea/gitea/pull/17879 * https://github.com/go-gitea/gitea/pull/17905
Author
Owner

@lunny commented on GitHub (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 commented on GitHub (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
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/gitea#2684