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

Point developers, managers, and client users to appropriate documentation for their use case #1356

Open
vitonsky opened this issue May 30, 2023 · 2 comments

Comments

@vitonsky
Copy link

Build process too confused for me as end user. It is reason why it looks the project have low maintenance quality and why i will not use this on my server.

All i need to run any good VPN is only one command to start server like make start, but instead of it i have to install node and some garbage on my server.

I suggest you to improve deploy process and to do:

  • add Dockerfile to build docker image with server
  • add makefile with script to build docker image and to start server
  • update readme with instruction what command should be started to run server

It's take 2 hour of your life to understand how docker works, but it significant improve usability and maintenance for users.

@maddyhof
Copy link

Thanks for reaching out. If I understand correctly, you're trying to install a shadowsocks server, right? If so, please refer to these instructions and reply with any specific steps that are confusing so that we can make sure to improve them.

As an alternative, you can use the Outline Manager to set up a manual server, which will prompt the same single command to install the server as the self-hosted installation instruction does.

@maddyhof maddyhof added the need more info We need more information in order to help or verify label May 30, 2023
@maddyhof maddyhof added this to Service Provider Issues in [DEPRECATED] Outline (Classic) May 30, 2023
@vitonsky
Copy link
Author

Now i see, instructions are clear. However, my first reaction when i see the README.md is "How it works? How i can start my own server? I don't see nothing about it, so documentation are bad for long term use, thus i should not wast time on explore this repository - next".

Consider my feedback as way to improve documentation for developers like me, who trying to not wast a time on projects with bad documentation.

For me looks confused a section "Components" that have links on important documents, but not explain what "Components" is and that i should to go to links to read docs for each component. It would enough to just add this explanation, let's do it.

image

@maddyhof maddyhof added feature request New feature or request and removed need more info We need more information in order to help or verify labels Jun 6, 2023
@maddyhof maddyhof changed the title Instructions are incredible hard and confused to just start VPN server Point developers, managers, and client users to appropriate documentation for their use case Jun 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
[DEPRECATED] Outline (Classic)
Service Provider Issues
Development

No branches or pull requests

2 participants