-
Notifications
You must be signed in to change notification settings - Fork 54
Documentation Full Rewrite (Standalone -> Docker) #172
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
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for pelica ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
…to docs-rewrite
|
idk, If this is really needed, since Proxys official Not supported |
Are you talking about the last part in the description? I feel as though providing "community guides" on how people can set them up would be useful. Obviously we can preface all of them saying that they aren't fool-proofed and support is limited, but having the information out there is good nonetheless and if they break, people can update them ! |
A complete rewrite of the documentation from beginning to end, with a re-arranged sidebar, renamed pages, and better documentation of the process from beginning to end for Docker installations, replacing the currently preferred standalone installation.
The intent of the rewrite is also to resolve issues with contextual assumptions within the documentation, where lines have been written assuming that the reader knows the Linux ecosystem well. Less ambiguous writing is provided, in order to help new folks who may struggle with Linux in order to guide them through the process without a lot of trouble on their end.
There are also intentions of expanding the documentation to provide more information (e.g. Cloudflare (Zero Trust), Pangolin, Egg Features, etc.) so that users are aware of what to do in these situations as opposed to having to rely on the Discord server to repeatedly answer the same questions.
CLARIFICATION This rewrite won't include new information, future PRs will handle such things. The intention of this PR is to rewrite the existing documentation to better suit Docker installations, and to create an improved layout that will lay the foundation for added content to the documentation such as community guides, how to create eggs and images (#151), and how to setup webhooks (#160).