Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Users can't edit wiki #1922

Open
CendioOssman opened this issue Dec 5, 2024 · 5 comments
Open

Users can't edit wiki #1922

CendioOssman opened this issue Dec 5, 2024 · 5 comments

Comments

@CendioOssman
Copy link
Member

Describe the bug
Only maintainers can currently edit our wiki, making it almost useless as the point of the wiki is to have documentation that the community can maintain.

Additional context
The reason the wiki is locked down is because there is too much malware being added to GitHub wikis. And GitHub provides absolutely no tools to deal with the issue.

In other words, getting GitHub doesn't seem feasible. We need to look at alternatives.

This could be an option where we can still host things on GitHub:

https://github.com/Drassil/git-wiki-theme

@pallandir
Copy link

Hi. Hope you're doing well.

Why not consider solutions like Astro.js and Starlight for documentation? (https://starlight.astro.build/) It can also be deployed to GitHub Pages (https://docs.astro.build/en/guides/deploy/github/). Let me know if I can help solve this issue.

@CendioOssman
Copy link
Member Author

That does not seem to be a wiki where users can contribute?

@pallandir
Copy link

Yes, you're right. It doesn't provide a direct way to collaborate online, and you would need pull requests as a normal project in order to accept documentation contributions. However, I thought about them because you would have better control (related to the malware issues of wikis) over the submissions, and they are still easy to deploy and setup.

@CendioOssman
Copy link
Member Author

A pull request based model could definitely be an option. I guess we'll need to set up one of these things and play around with it.

@pallandir
Copy link

pallandir commented Feb 26, 2025

Starlight Demo

I've built a quick demo showcasing how Starlight documentation could look like! You can check it out here:

🔗 Documentation demo

Considerations

  • Documentation under src/content/docs/documentation is autogenerated. (As long as you create a folder or file here it will appear in the sidebar once running the project)
  • Landing page is the default Hero but it can be anything.
  • Contributing to this project can be editing documetation under src/content/docs or updating the site itself (configuration, UI ...)
  • Documentation can be written as Markdown or mdx : more on this here
  • Each documentation file has to contain default title (only field mandatory) and can be customized thanks to frontmatter.

Setup and deployment

This project can be added to an already existing repository under a subfolder (e.g /docs) or into a new one to split actual implementation of NoVnc and its documentation.

Deployment can be done with GitHub pages or any other host: deploy astro project

Final words

If you feel this solution can be relevant for your use-case I would be open and interested to contribute to its implementation / configuration / documentation migration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants