gitea-mirror
/
blog
mirror of https://gitea.com/gitea/blog.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Introducing Versioned Documentation (#247) 

cc: @delvh not sure if you want to add yourself as an author for this too, as I believe you provided edits to the draft

Reviewed-on: https://gitea.com/gitea/blog/pulls/247
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-by: John Olheiser <john+gitea@jolheiser.com>
Reviewed-by: delvh <dev.lh@web.de>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
Co-committed-by: techknowlogick <techknowlogick@gitea.io>
This commit is contained in:
techknowlogick 2023-03-28 08:09:34 +08:00 committed by Lunny Xiao
parent b42462146d
commit 4a6b3fdd30
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
content/post/introducing-versioned-documentation.md Normal file
View File

@ -0,0 +1,20 @@
---
date: "2023-03-27T13:00:00+01:00"
author: "techknowlogick"
title: "Introducing Versioned Documentation"
draft: false
---
The [documentation site](https://docs.gitea.io) has hosted the nightly documentation for the project for a long time now.
This works in the majority of cases when someone is referring to the docs to support their Gitea instance.
However, sometimes when a highly anticipated feature is merged into the development branch and the documentation is included, users who may not keep up with the release cycle run into problems when attempting to activate or configure functionality that isn't yet in a stable release.
For example, as new package registries have been added, some didn't have hints as to which version they were added in, and we subsequently became swamped with questions why the newly added package registry was not present in their instance.
We have been working on versioned documentation for the past year, so that users can access the documentation that matches the version of Gitea they are using, ensuring that they get accurate and up-to-date information.
The new documentation site is built using [Docusaurus](https://docusaurus.io/), and is deployed through Gitea Actions. Thanks to the Docusaurus team for their work building docusaurus. Docusaurus is one of the upstream projects that Gitea sponsors, and you can also sponsor them on [Open Collective](https://opencollective.com/docusaurus).
Translations are currently a work in progress.
We are working with the translators on adding the documentation to the translation tool, so that translated documentation can be kept up to date.
Please browse the [new documentation site](https://docs.gitea.com) at https://docs.gitea.com, and report any errors/issues to the [repo](https://gitea.com/gitea/gitea-docusaurus). Redirects from the old documentation site will be put in place over the next month.