Introducing Versioned Documentation #247

Merged
lunny merged 4 commits from docusaurus-docs into main 2023-03-28 00:09:35 +00:00

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

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
techknowlogick added 1 commit 2023-03-25 20:31:31 +00:00
All checks were successful
continuous-integration/drone/pr Build is passing
99b19772b7
add blog post re: docusaurus
First-time contributor
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/
Owner

I don't think it's necessary.
I mean, I edited a few phrases.
However, the large majority of text is still from you.

I don't think it's necessary. I mean, I edited a few phrases. However, the large majority of text is still from you.
lunny approved these changes 2023-03-26 03:30:02 +00:00
delvh reviewed 2023-03-26 11:39:46 +00:00
@ -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).
Owner

, they are one of the upstream projects that sponsors

How exactly am I supposed to interpret this sentence?
Do they sponsor Gitea, does Gitea sponsor them, or something completely different?

> , they are one of the upstream projects that sponsors How exactly am I supposed to interpret this sentence? Do they sponsor Gitea, does Gitea sponsor them, or something completely different?
techknowlogick marked this conversation as resolved
techknowlogick added 1 commit 2023-03-27 21:05:44 +00:00
All checks were successful
continuous-integration/drone/pr Build is passing
ef2a2c8587
clarify sentence
techknowlogick reviewed 2023-03-27 21:07:02 +00:00
@ -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).
Author
Owner

Do they sponsor Gitea, does Gitea sponsor them, or something completely different?

Good catch, this is indeed an unclear (and unfinished) sentence. It should say that we are sponsoring them. I will update now.

> Do they sponsor Gitea, does Gitea sponsor them, or something completely different? Good catch, this is indeed an unclear (and unfinished) sentence. It should say that we are sponsoring them. I will update now.
techknowlogick marked this conversation as resolved
jolheiser reviewed 2023-03-27 21:14:27 +00:00
@ -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.
Owner

However, sometimes [...]
It wasn't clear to me on first read that this was a "but"

`However, sometimes [...]` It wasn't clear to me on first read that this was a "but"
jolheiser marked this conversation as resolved
@ -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).
Owner

Thanks to the docusaurus team for their work! They [...]
Current reading sounds like the docu team worked on our project.

`Thanks to the docusaurus team for their work! They [...]` Current reading sounds like the docu team worked on _our_ project.
jolheiser marked this conversation as resolved
@ -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.
Owner

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)

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)
techknowlogick marked this conversation as resolved
techknowlogick added 1 commit 2023-03-27 21:16:45 +00:00
All checks were successful
continuous-integration/drone/pr Build is passing
1df7dba3fc
update a few nits
techknowlogick reviewed 2023-03-27 21:19:59 +00:00
@ -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.
Author
Owner

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.

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.
jolheiser marked this conversation as resolved
techknowlogick reviewed 2023-03-27 21:20:11 +00:00
@ -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.
Author
Owner

updated

updated
jolheiser marked this conversation as resolved
jolheiser approved these changes 2023-03-27 21:21:23 +00:00
jolheiser reviewed 2023-03-27 21:22:35 +00:00
@ -0,0 +1,20 @@
---
date: "2023-03-25T13:00:00+01:00"
Owner

Up to you if you want to update this or leave it as-is, just a ping to let you know. 🙂

Up to you if you want to update this or leave it as-is, just a ping to let you know. 🙂
delvh approved these changes 2023-03-27 21:25:42 +00:00
techknowlogick added 1 commit 2023-03-27 21:27:46 +00:00
All checks were successful
continuous-integration/drone/pr Build is passing
5818f6944f
update date
lunny merged commit 4a6b3fdd30 into main 2023-03-28 00:09:35 +00:00
techknowlogick deleted branch docusaurus-docs 2023-03-28 01:21:23 +00:00
Sign in to join this conversation.
No description provided.