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

doc: rework installation/setup guides, general refactoring #1389

Merged
merged 43 commits into from
Sep 12, 2020

Conversation

nodiscc
Copy link
Member

@nodiscc nodiscc commented Jan 3, 2020

A full and concise installation guide with examples is a frequent request.

The documentation should provide such a guide for basic installation needs, while explaining alternative/advanced configuration at the end of teh document.

Links to reference guides and documentation should be used more frequently to avoid recommending an outdated or excessively complex configuration.

Ideally the download, installation, server setup and security sections should fit on a single page.

Another page can walk the user through installing Shaarli in Docker behind a reverse proxy.

@nodiscc
Copy link
Member Author

nodiscc commented Apr 11, 2020

Still work in progress, see:

As you can see this PR also proposes dropping support for the stable branch. I think the current model is complex/confusing, it adds maintenance and has no great benefits. Under the proposed model you can:

  • Install the latest tag/release using any available method (release zip, git clone/zip + composer). Upgrades to the next release must be done manually (overwrite with new zip contents, or git remote update; git checkout new_tag; composer ...)
  • Install the release branch from git clone/zip (the only benefit git remote update; git checkout is simply replaced with git pull), or the master branch using the same method.

In short the release branch would now be considered as stable (in its current form it's kind of like an oldstable branch.). What do you think?

@k4j8
Copy link

k4j8 commented May 1, 2020

In doc/md/Server-configuration.md, I had to have the Directory section outside of VirtualHost rather than within it, but it may be my configuration (see #1423). I also had to change the configuration within Directory as a result of running a newer version of Apache. See http://httpd.apache.org/docs/current/upgrading.html.

I'm running Arch Linux and have only had my webserver for a few months. If it works for you, feel free to ignore.

@nodiscc
Copy link
Member Author

nodiscc commented May 1, 2020

I will definitely re-test all setup procedures before removing the work-in-progress status. Apache 2.4 will be used for the test. <Directory> should work inside a virtualhost definition but I will double-check everything, thanks

@nodiscc
Copy link
Member Author

nodiscc commented May 16, 2020

Rebased, squashed.

I still have to test some procedures and change ordering (for example I know the setup procedure still takes you back and forth between 2 pages), but the bulk of it is done. Let me know what you think.

@nodiscc nodiscc changed the title WIP: rework download, installation and server setup guide Rework download, installation and server setup guide May 16, 2020
Copy link
Member

@ArthurHoaro ArthurHoaro left a comment

Choose a reason for hiding this comment

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

Impressive work!
I did not reread everything as it's quite hard to follow the moved part, but the result you linked looks great to me.

@nodiscc nodiscc changed the title Rework download, installation and server setup guide doc: rework installation/setup guides, general refactoring May 25, 2020
@nodiscc nodiscc removed the in review label Jun 2, 2020
@nodiscc nodiscc changed the title doc: rework installation/setup guides, general refactoring WIP: doc: rework installation/setup guides, general refactoring Jun 2, 2020
@nodiscc
Copy link
Member Author

nodiscc commented Jun 18, 2020

I solved my NAT problems which were preventing me from testing install procedures with proper Let's Encrypt certificate generation. I will do another pass this weekend and probably include some asccinema demos of the process.

nodiscc and others added 25 commits September 12, 2020 14:31
…on, move reference links to their respective sections, shorten
Besides adding 2 new plugins, also reordered the list by ABC and fixed some discrepancies in the details to restore balance in the force
@nodiscc
Copy link
Member Author

nodiscc commented Sep 12, 2020

rebased.

@nodiscc nodiscc merged commit e809908 into master Sep 12, 2020
@nodiscc nodiscc deleted the doc-rework-setup branch September 12, 2020 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Question] Example for independent nginx deployment [Install Issue] 403 Forbidden
6 participants