Introducing Versioned Documentation #247
Labels
No Label
in progress
kind/bug
kind/deployment
kind/docs
kind/enhancement
kind/feature
kind/lint
kind/proposal
kind/question
kind/security
kind/testing
kind/translation
kind/ui
lgtm/done
lgtm/need 1
lgtm/need 2
priority/critical
priority/low
priority/maybe
priority/medium
reviewed/duplicate
reviewed/invalid
reviewed/wontfix
status/blocked
status/needs-feedback
status/wip
No Milestone
No Assignees
5 Participants
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: gitea/blog#247
Loading…
Reference in New Issue
Block a user
No description provided.
Delete Branch "docusaurus-docs"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
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
Website preview: http://preview-gitea-org-blog-blog-247.s3-website.eu-central-1.amazonaws.com/
Link to blog post: http://preview-gitea-org-blog-blog-247.s3-website.eu-central-1.amazonaws.com/2023/03/introducing-versioned-documentation/
I don't think it's necessary.
I mean, I edited a few phrases.
However, the large majority of text is still from you.
@ -0,0 +12,4 @@
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 on this project, they are one of the upstream projects that sponsors, and you can also sponsor them on [Open Collective](https://opencollective.com/docusaurus).
How exactly am I supposed to interpret this sentence?
Do they sponsor Gitea, does Gitea sponsor them, or something completely different?
@ -0,0 +12,4 @@
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 on this project, they are one of the upstream projects that sponsors, and you can also sponsor them on [Open Collective](https://opencollective.com/docusaurus).
Good catch, this is indeed an unclear (and unfinished) sentence. It should say that we are sponsoring them. I will update now.
@ -0,0 +7,4 @@
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.
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.
However, sometimes [...]
It wasn't clear to me on first read that this was a "but"
@ -0,0 +12,4 @@
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 on this project, they are one of the upstream projects that Gitea sponsors, and you can also sponsor them on [Open Collective](https://opencollective.com/docusaurus).
Thanks to the docusaurus team for their work! They [...]
Current reading sounds like the docu team worked on our project.
@ -0,0 +17,4 @@
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.
Maybe unlink
new documentation site
, only because otherwise there will be two links going to the same place in the same sentence within a few words. (This is probably a minor nit, just something I noticed)@ -0,0 +17,4 @@
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.
I had it both ways, so that there was something to click and that people could see the full link. I had linked the text for accessibility reasons, so screen readers could tell the purpose behind the link.
@ -0,0 +7,4 @@
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.
updated
@ -0,0 +1,20 @@
---
date: "2023-03-25T13:00:00+01:00"
Up to you if you want to update this or leave it as-is, just a ping to let you know. 🙂