search

Vanilla-OS / documentation

Find out how to use Vanilla OS and all its tools and settings.
http://documentation.vanillaos.org/
GNU Affero General Public License v3.0
52 stars 26 forks source link

Mark this repo as deprecated and clone voxelin/altdoc. #71

Closed kyee-rs closed 1 year ago

kyee-rs commented 1 year ago

Hello, since this repo uses Jekyll for its documentation system, it may be hard to implement translations, plugins, change styles. I made a remake of this repo, which contains all the information (including translations), written on Docusaurus. Thank you.

mirkobrombin commented 1 year ago

We currently host the documentation on GitHub. How will be with docusaurus?

kbdharun commented 1 year ago

We currently host the documentation on GitHub. How will be with docusaurus?

The person seem to suggest using netlify, more info on #docs-writing

kyee-rs commented 1 year ago

We currently host the documentation on GitHub. How will be with docusaurus?

Thanks for your reply. I recommend you seeing this article: https://docusaurus.io/docs/deployment#deploying-to-github-pages. In short, github pages are also supported by this framework.

kyee-rs commented 1 year ago

To be clear, i would also recommend you using Netlify, as it is free service that provides more advanced functionality than Github Pages do. As an example, with Docusaurus deployments will be automatically checked for errors in Markdown files (Broken links, invalid syntax, etc.). Also, Netlify does provide Netlify Edge Functions, that allow some back-end stuff and regional redirects (Useful for i18n). Sorry for such a long-read text but I hope you will agree on this changes. Thank you for your time.

mirkobrombin commented 1 year ago

I feel comfortable with Github. To make this happen we need to configure the github action for the deployment. And maybe open a PR.

kyee-rs commented 1 year ago

I feel comfortable with Github. To make this happen we need to configure the github action for the deployment. And maybe open a PR.

If i configure it for your repo, will you merge it with all the changes with docusaurus?

kyee-rs commented 1 year ago

See #73. Thanks.