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

[docs] Revamp the installation guide #1877

Merged
merged 1 commit into from
Jun 10, 2023

Conversation

daenney
Copy link
Member

@daenney daenney commented Jun 8, 2023

Description

If this is a code change, please include a summary of what you've coded, and link to the issue(s) it closes/implements.

If this is a documentation change, please briefly describe what you've changed and why.

This tries to revamp/restructure the installation guide. It's renamed to "Getting Started" as it now contains a few more things than just the installation, especially the deployment considerations which we didn't use to spell out as much ahead of time.

Installation is now a section with the guides on their own and I did the same for reverse proxies. I've removed a bit of redundancy like the user creation. I also removed the rogue reverse proxy section in the Docker guide and lifted that into the reverse proxy section.

Checklist

Please put an x inside each checkbox to indicate that you've read and followed it: [ ] -> [x]

If this is a documentation change, only the first checkbox must be filled (you can delete the others if you want).

  • I/we have read the GoToSocial contribution guidelines.
  • I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat.
  • I/we have performed a self-review of added code.
  • I/we have written code that is legible and maintainable by others.
  • I/we have commented the added code, particularly in hard-to-understand areas.
  • I/we have made any necessary changes to documentation.
  • I/we have added tests that cover new code.
  • I/we have run tests and they pass locally with the changes.
  • I/we have run go fmt ./... and golangci-lint run.

@daenney
Copy link
Member Author

daenney commented Jun 8, 2023

I have some ideas on how to rewrite the installation guides themselves too to hopefully make them a bit more approachable. But that's a separate thing and this was already getting quite big.

@daenney
Copy link
Member Author

daenney commented Jun 8, 2023

https://gotosocial--1877.org.readthedocs.build/en/1877/ shows the docs as created by this PR.

@tsmethurst
Copy link
Contributor

Excellent! Thank you! This was much needed. Could you resolve the conflict? Then I'll merge this :)

This tries to revamp/restructure the installation guide. It's renamed to
"Getting Started" as it now contains a few more things than just the
installation, especially the deployment considerations which we didn't
use to spell out as much ahead of time.

Installation is now a section with the guides on their own. I've removed
a bit of redundancy like the user creation. I also removed the rogue
reverse proxy section in the Docker guide and lifted that into the
reverse proxy section.
@daenney
Copy link
Member Author

daenney commented Jun 9, 2023

Git got confused over some file path moves when I tried to rebase so I rewrote the commit. But same as before, just with the tracing thing in the user guide now too.

@tsmethurst tsmethurst merged commit 84e1c7a into superseriousbusiness:main Jun 10, 2023
2 checks passed
@daenney daenney deleted the docs-rework branch June 10, 2023 15:03
tsmethurst pushed a commit that referenced this pull request Jun 14, 2023
This tries to revamp/restructure the installation guide. It's renamed to
"Getting Started" as it now contains a few more things than just the
installation, especially the deployment considerations which we didn't
use to spell out as much ahead of time.

Installation is now a section with the guides on their own. I've removed
a bit of redundancy like the user creation. I also removed the rogue
reverse proxy section in the Docker guide and lifted that into the
reverse proxy section.
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

Successfully merging this pull request may close these issues.

None yet

3 participants