HesterG
dab0be78b2
# Notes - date must not have double quotes, e.g., should be like `date: 2022-10-30T18:25:00+09:15` - Updated header.  - Used customized blog plugin to get all tags with reference to [plugins/blog/index.js](https://github.com/questdb/questdb.io/blob/master/plugins/blog/index.js). Filter by tag section, tag list page.   - Added coverImage to frontmatter to assgin cover image, e.g., `coverImage: "/img/blog-covers/test.jpeg"` And on blog page, cover image will appear on top if `coverImage` added to frontmatter, e.g.,   - authors are managed by the `authors.yml` file. [reference](https://docusaurus.io/docs/blog#global-authors) - [ejected](https://docusaurus.io/docs/swizzling#ejecting) `@docusaurus/theme-classic BlogListPage` and `@docusaurus/theme-classic BlogPostPage`, which are marked as `unsafe` by docusaurus, so need to maintain these components. ([original BlogListPage](https://github.com/facebook/docusaurus/blob/main/packages/docusaurus-theme-classic/src/theme/BlogListPage/index.tsx), [original BlogPostPage](https://github.com/facebook/docusaurus/blob/main/packages/docusaurus-theme-classic/src/theme/BlogPostPage/index.tsx)) - [referenced repo](https://github.com/questdb/questdb.io) # How to test ``` npm i npm run start ``` # Build and serve ``` npm run build npm run serve ``` # Help Needed Deploy and preview steps # More Screenshots  Mobile:      # TODO - [x] Add Banner to blog page Reviewed-on: gitea/blog#266 Co-authored-by: HesterG <hestergong@gmail.com> Co-committed-by: HesterG <hestergong@gmail.com>
1.9 KiB
| date | authors | title | tags | draft | |
|---|---|---|---|---|---|
| 2023-03-27T13:00:00+01:00 | techknowlogick | Introducing Versioned Documentation |
|
false |
The documentation site 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, 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.
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 at https://docs.gitea.com, and report any errors/issues to the repo. Redirects from the old documentation site will be put in place over the next month.