Conversation
6911a96 to
d207938
Compare
|
I normally interpret "install" as something an end-user would do to have a software ready to use in their system. These |
In the context of this codebase an end-user is someone visiting the site. They don't have to install anything and should never need to look at the files in git. INSTALL.md is targeted at people using the code, rather than end-users who interact with the result of the code (the website). Most of the users of the code will be developers running it locally or non-OSM sites running a variant of the code in production. |
|
Re: Note that (at least in my understanding) the Having said that, perhaps there's a better, more conventional name that can be used. I'm not sure where to find the full list. The closest I've found is https://github.com/danpoynor/special-github-files, but it's unofficial. |
INSTALL.md comes from the long-standing GNU standards and is what is commonly used. As far as I know it has no special significance to Github. |
eac9331 to
57d4986
Compare
8ec8fdb to
14b95d3
Compare
1e3aff4 to
2fae21a
Compare
23ad283 to
9fc0b3e
Compare
|
I have now rebased (actually redone from scratch) this PR, after the merge of #6424. It's ready to be reviewed. |
1072453 to
e8e2ad9
Compare
fe416eb to
f7b0789
Compare
f7b0789 to
e95a241
Compare
|
Apologies for the merge commit. After some head scratching wondering where that had come from, I realised that I had clicked a button that GitHub makes all too easy to click by mistake. It's fixed now. |
tomhughes
left a comment
There was a problem hiding this comment.
This looks good to me now, thanks.
As part of #6424, new documentation was added that duplicated the existing one, which in turn had substantial duplication already.
I propose that we DRY up the existing docs a little bit, splitting it as follows:
Details:
CONTRIBUTING.mdwe link toINSTALL.md, which in turn gives options to the reader to continue with eitherDOCKER.md,DEVCONTAINER.md, orMANUAL_INSTALL.md. We could also separate therbenvstuff into its own file.CONFIGURE.mdafter the install. All this stuff is common to all methods.