search

junkurihara / rust-rpxy

A simple and ultrafast http reverse proxy serving multiple domain names and terminating TLS for http/1.1, 2 and 3, written in Rust
https://rpxy.io/
MIT License
315 stars 35 forks source link

Website for configuration documentation #186

Open junkurihara opened 2 months ago

junkurihara commented 2 months ago

As I mentioned in #165.

I actually know the current README.md and config-example.toml are not user-friendly, especially for the upstream_options. So I think we should prepare a website of the documentation of rxpy configuration.

Any opinion?

junkurihara commented 2 months ago

Webpage repo: https://github.com/junkurihara/rpxy-web Just created and not yet deployed.

Gamerboy59 commented 2 months ago

I suggest renaming the repo to rpxy-docs so there is no confusion with rpxy-webui (web and webui is very similar).

junkurihara commented 2 months ago

@Gamerboy59 Agree. Will change it.

Or else, should we put it in ./docs directory of this repo?

Gamerboy59 commented 2 months ago

Where the website is stored depends on the scope of the docs imo. Comprehensive documentation is usually placed in a separate repository for better management of multiple files, their relationships and to handle issues, pull requests, and versioning independently from the main application. A single-page documentation fits in a subfolder.
You favored a more complete documentation in #165 hence I'd vote to keep it in a separated repo and see to which size the docs will grow. I think tools like MkDocs or Docusaurus can be used together with Github Actions in Github Pages so the website generation can be slightly automated. Tools like Hugo can be used for automation if we are not going to use a documentation website framework. I haven't extensively tried either of them yet.

junkurihara commented 1 month ago

@Gamerboy59 Thanks! (and sorry for my delayed reply)

I just deployed a skeleton of rpxy documentation website from https://github.com/junkurihara/rpxy-docs with Hugo. Now the skeleton is hosted on https://rpxy.io.

I have used the framework, but I completely forgot how to configure it. So, it took a time.

Anyways, I will update and add content of the documentation repo.

junkurihara commented 1 month ago

oh... Should I move to rpxy.org or rpxy.net just in case?

https://www.theverge.com/2024/10/8/24265441/uk-treaty-end-io-domain-chagos-islands

Gamerboy59 commented 1 month ago

Hi @junkurihara I've read about this .io Domain problem too but I doubt it'll have a big impact for now. They still make good money from this domain extension so I suppose they'll find an organization which continoues it.
Also, I really like the design of the docs website, flat and clean. I need to get used to Hugo again too, then I'll send PR with some content as well. Nice work so far. :)

junkurihara commented 1 month ago

Hi @Gamerboy59

I agree with you for the io domain, so let us keep it as is for now.

Thanks for checking the docs! I am gradually updating the docs, but it is slow and I need time to write new content. So PR is really welcome!!