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

Add tutorial for how to improve public instance + rework current pages #464

Merged
merged 4 commits into from
Nov 4, 2023

Conversation

unixfox
Copy link
Member

@unixfox unixfox commented Nov 4, 2023

Related to #350

This PR explains how to improve the performance and stability of a public instance.

And it reorganizes the pages for the public instance owners in a dedicated section.

Also remove the tutorial about anticaptcha because that's completely out of date and doesn't work anymore. We can always restore the page later if we really need it.

Copy link

@absidue absidue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi
Here are a few suggestions to improve the tutorial (typos, grammar and rewording a sentence).

docs/improve-public-instance.md Outdated Show resolved Hide resolved
docs/improve-public-instance.md Outdated Show resolved Hide resolved
docs/improve-public-instance.md Outdated Show resolved Hide resolved
docs/improve-public-instance.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved

This tutorial has been written by [unixfox](https://github.com/unixfox), owner of [yewtu.be](https://yewtu.be/). He is better suited when looking for help about this tutorial.

## Synopsis
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Synopsis
## Introduction

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm keeping Synopsis it's valid :D

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A synopsis is used for movies and stories, not really for technical documents.... so it's not great.

docs/improve-public-instance.md Outdated Show resolved Hide resolved
docs/improve-public-instance.md Outdated Show resolved Hide resolved
docs/improve-public-instance.md Outdated Show resolved Hide resolved
Comment on lines 85 to 87
NGINX configuration will be used for this tutorial, and it's highly recommended to setup this configuration on your main reverse proxy.

But if you do not have NGINX as your main reverse proxy you can either try to adapt the rules to your reverse proxy. Or you can also use the separate NGINX container from the [first section](#1-multiple-invidious-processes).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The previous setup implies that NGINX is used, it's not great to imply something else here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no the previous setup do not require NGINX, NGINX is used as a middleman

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh... ok. That's a bit confusing then, maybe add a warning that we're not talking about the middleman setup previously.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's why I wrote "main reverse proxy". I made it so it's in bold now.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, sure I did see it, but it's a bit confusing. I guess we'll see if people get confused when they set it up.

docs/improve-public-instance.md Outdated Show resolved Hide resolved
docs/improve-public-instance.md Outdated Show resolved Hide resolved
docs/improve-public-instance.md Outdated Show resolved Hide resolved
@unixfox unixfox merged commit c5c1fd2 into master Nov 4, 2023
@unixfox unixfox deleted the tuto-improve-public-instance branch November 4, 2023 15:03
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.

3 participants