Incorrect document version #14211

Closed
opened 2025-11-02 11:06:29 -06:00 by GiteaMirror · 11 comments
Owner

Originally created by @wxiaoguang on GitHub (Mar 3, 2025).

https://docs.gitea.com/usage/authentication#reverse-proxy

Image

@lunny @techknowlogick

Originally created by @wxiaoguang on GitHub (Mar 3, 2025). https://docs.gitea.com/usage/authentication#reverse-proxy ![Image](https://github.com/user-attachments/assets/d20e3341-a24d-4335-880c-bff68dcb6bf0) @lunny @techknowlogick
Author
Owner

@lunny commented on GitHub (Mar 3, 2025):

This is caused by the authentication have been moved to https://docs.gitea.com/administration/authentication in v1.23. In theory, the old documentation should be removed but not.

@lunny commented on GitHub (Mar 3, 2025): This is caused by the authentication have been moved to https://docs.gitea.com/administration/authentication in v1.23. In theory, the old documentation should be removed but not.
Author
Owner

@wxiaoguang commented on GitHub (Mar 3, 2025):

Actually only a few documents need to be really "versioned".

Most page could simply share the same version, no need to duplicate the documents a lot for different versions.

At the moment, only "config options" is the only page which really need to be versioned, see https://github.com/go-gitea/gitea/pull/17879

@wxiaoguang commented on GitHub (Mar 3, 2025): Actually only a few documents need to be really "versioned". Most page could simply share the same version, no need to duplicate the documents a lot for different versions. At the moment, only "config options" is the only page which really need to be versioned, see https://github.com/go-gitea/gitea/pull/17879
Author
Owner

@wxiaoguang commented on GitHub (Apr 3, 2025):

@lunny @techknowlogick

I would still consider the current directory layout is problematic.

For example: 1.23 is missing?

The only page (or a few pages) which require "versioned" is the config cheat sheet.

All other pages should share the same pages.

Image

@wxiaoguang commented on GitHub (Apr 3, 2025): @lunny @techknowlogick I would still consider the current directory layout is problematic. For example: `1.23` is missing? The only page (or a few pages) which require "versioned" is the config cheat sheet. All other pages should share the same pages. <details> ![Image](https://github.com/user-attachments/assets/3c24935d-2050-4234-98c8-ec9a83ade0ec) </details>
Author
Owner

@wxiaoguang commented on GitHub (Apr 24, 2025):

Is it Gitea community's culture that "never respond"?

@wxiaoguang commented on GitHub (Apr 24, 2025): Is it Gitea community's culture that "never respond"?
Author
Owner

@lunny commented on GitHub (Apr 24, 2025):

This page is a cache/dirty page. It should not be linked from the normal home page.

@lunny commented on GitHub (Apr 24, 2025): This page is a cache/dirty page. It should not be linked from the normal home page.
Author
Owner

@wxiaoguang commented on GitHub (Apr 24, 2025):

The only page (or a few pages) which require "versioned" is the config cheat sheet.
All other pages should share the same pages.

What do you think about this?

@wxiaoguang commented on GitHub (Apr 24, 2025): > The only page (or a few pages) which require "versioned" is the config cheat sheet. > All other pages should share the same pages. What do you think about this?
Author
Owner

@lunny commented on GitHub (Apr 24, 2025):

The only page (or a few pages) which require "versioned" is the config cheat sheet.
All other pages should share the same pages.

What do you think about this?

Some features will only happen in dev version and some features may be changed. I don't think it's enough for only versioned config cheat sheet.

@lunny commented on GitHub (Apr 24, 2025): > > The only page (or a few pages) which require "versioned" is the config cheat sheet. > > All other pages should share the same pages. > > What do you think about this? Some features will only happen in dev version and some features may be changed. I don't think it's enough for only versioned config cheat sheet.
Author
Owner

@wxiaoguang commented on GitHub (Apr 24, 2025):

The only page (or a few pages) which require "versioned" is the config cheat sheet.
All other pages should share the same pages.

What do you think about this?

Some features will only happen in dev version and some features may be changed. I don't think it's enough for only versioned config cheat sheet.

For example? All new features we could just mark them as something like "For 1.24 and later".

@wxiaoguang commented on GitHub (Apr 24, 2025): > > > The only page (or a few pages) which require "versioned" is the config cheat sheet. > > > All other pages should share the same pages. > > > > > > What do you think about this? > > Some features will only happen in dev version and some features may be changed. I don't think it's enough for only versioned config cheat sheet. For example? All new features we could just mark them as something like "For 1.24 and later".
Author
Owner

@wxiaoguang commented on GitHub (Apr 24, 2025):

Do you see other successful products manage documents as Gitea does? For example: https://docs.gitlab.com ? I believe they do as what I said.

@wxiaoguang commented on GitHub (Apr 24, 2025): Do you see other successful products manage documents as Gitea does? For example: https://docs.gitlab.com ? I believe they do as what I said.
Author
Owner

@wxiaoguang commented on GitHub (Apr 24, 2025):

OK, gitlab also shows 404 for old pages. So maybe nothing to do.

At least, Gitlab tells users how to access the latest document.

Image

Image

@wxiaoguang commented on GitHub (Apr 24, 2025): OK, gitlab also shows 404 for old pages. So maybe nothing to do. At least, Gitlab tells users how to access the latest document. ![Image](https://github.com/user-attachments/assets/9e4fdbd2-7b29-4048-be94-b01df4061aa5) ![Image](https://github.com/user-attachments/assets/ba095eaa-52df-481f-ae71-288816c87393)
Author
Owner

@lunny commented on GitHub (Apr 24, 2025):

I think we can do two things.

  • Remove the cache/dirty pages when updating new version. This should be careful because some sub directories are generated from different repositories. Some sub directories like api, runner, enterprise should be kept when updating the gitea's documentations.
  • Improve the 404 page and have some guide like what GitLab did.

Recorded here https://gitea.com/gitea/docs/issues/213

@lunny commented on GitHub (Apr 24, 2025): I think we can do two things. - Remove the cache/dirty pages when updating new version. This should be careful because some sub directories are generated from different repositories. Some sub directories like `api`, `runner`, `enterprise` should be kept when updating the gitea's documentations. - Improve the 404 page and have some guide like what GitLab did. Recorded here https://gitea.com/gitea/docs/issues/213
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/gitea#14211