As part of #6424, I'll have to add documentation that will duplicate the
existing one, which in turn has substantial duplication.
So I was thinking: how about we DRY up the existing docs a little bit first?
I'm proposing we split it as follows:
```
CONTRIBUTING.md
README.md
SECURITY.md
doc
├── CONFIGURE.md
├── DOCKER_INSTALL.md
├── FAQ.md
├── INSTALL.md
└── MANUAL_INSTALL.md
```
Details:
- I'm leaving in the root dir the files that I think are standard to find
there (I need to double check).
- From `CONTRIBUTING.md` we link to `INSTALL.md`, which gives options to the
reader to continue with either `DOCKER_INSTALL.md` or `MANUAL_INSTALL.md`.
- A new `DEVCONTAINER_INSTALL.md` can join in the future, and we could also
separate the `rbenv` stuff into its own file.
- Regardless of the chosen option, the user is sent to `CONFIGURE.md` after the
install. All this stuff is common to all methods.
Thoughts? Note that this is only a draft, to get your impressions before
investing more time.
You can view, comment on, or merge this pull request online at:
https://github.com/openstreetmap/openstreetmap-website/pull/6458
-- Commit Summary --
* Documentation review
* Move files into doc/
* DRY documentation
-- File Changes --
M .gitignore (1)
M CONTRIBUTING.md (4)
M README.md (2)
M config/docker.database.yml (2)
R doc/CONFIGURE.md (0)
R doc/DOCKER_INSTALL.md (97)
R doc/FAQ.md (0)
A doc/INSTALL.md (40)
R doc/MANUAL_INSTALL.md (137)
-- Patch Links --
https://github.com/openstreetmap/openstreetmap-website/pull/6458.patch
https://github.com/openstreetmap/openstreetmap-website/pull/6458.diff
--
Reply to this email directly or view it on GitHub:
https://github.com/openstreetmap/openstreetmap-website/pull/6458
You are receiving this because you are subscribed to this thread.
Message ID: <openstreetmap/openstreetmap-website/pull/[email protected]>
_______________________________________________
rails-dev mailing list
[email protected]
https://lists.openstreetmap.org/listinfo/rails-dev
