<p dir="auto">As part of <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="3474165426" data-permission-text="Title is private" data-url="https://github.com/openstreetmap/openstreetmap-website/issues/6424" data-hovercard-type="pull_request" data-hovercard-url="/openstreetmap/openstreetmap-website/pull/6424/hovercard" href="https://github.com/openstreetmap/openstreetmap-website/pull/6424">#6424</a>, I'll have to add documentation that will duplicate the existing one, which in turn has substantial duplication.</p>
<p dir="auto">So I was thinking: how about we DRY up the existing docs a little bit first? I'm proposing we split it as follows:</p>
<pre class="notranslate"><code class="notranslate">CONTRIBUTING.md
README.md
SECURITY.md
doc
├── CONFIGURE.md
├── DOCKER_INSTALL.md
├── FAQ.md
├── INSTALL.md
└── MANUAL_INSTALL.md
</code></pre>
<p dir="auto">Details:</p>
<ul dir="auto">
<li>I'm leaving in the root dir the files that I think are standard to find there (I need to double check).</li>
<li>From <code class="notranslate">CONTRIBUTING.md</code> we link to <code class="notranslate">INSTALL.md</code>, which gives options to the reader to continue with either <code class="notranslate">DOCKER_INSTALL.md</code> or <code class="notranslate">MANUAL_INSTALL.md</code>.
<ul dir="auto">
<li>A new <code class="notranslate">DEVCONTAINER_INSTALL.md</code> can join in the future, and we could also separate the <code class="notranslate">rbenv</code> stuff into its own file.</li>
</ul>
</li>
<li>Regardless of the chosen option, the user is sent to <code class="notranslate">CONFIGURE.md</code> after the install. All this stuff is common to all methods.</li>
</ul>
<p dir="auto">Thoughts? Note that this is only a draft, to get your impressions before investing more time.</p>
<hr>
<h4>You can view, comment on, or merge this pull request online at:</h4>
<p> <a href='https://github.com/openstreetmap/openstreetmap-website/pull/6458'>https://github.com/openstreetmap/openstreetmap-website/pull/6458</a></p>
<h4>Commit Summary</h4>
<ul>
<li><a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458/commits/75a5b4401db187f78eccc31c7a5c16e5f1e314d2" class="commit-link">75a5b44</a> Documentation review</li>
<li><a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458/commits/cae36508c4f8043706e4b26c82acdb55a5958e48" class="commit-link">cae3650</a> Move files into doc/</li>
<li><a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458/commits/6911a96e7ffea5444852529695f9ba24af12eba6" class="commit-link">6911a96</a> DRY documentation</li>
</ul>
<h4 style="display: inline-block">File Changes </h4> <p style="display: inline-block">(<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458/files">9 files</a>)</p>
<ul>
<li>
<strong>M</strong>
<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458/files#diff-bc37d034bad564583790a46f19d807abfe519c5671395fd494d8cce506c42947">.gitignore</a>
(1)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458/files#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055">CONTRIBUTING.md</a>
(4)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5">README.md</a>
(2)
</li>
<li>
<strong>M</strong>
<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458/files#diff-c8f1ef8be12ee9aff9ad3409602504f5298b02b24641451941d9ce9b298662d1">config/docker.database.yml</a>
(2)
</li>
<li>
<strong>R</strong>
<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458/files#diff-8a5ea446c4814e9504ef4c14a2644f55df726dc8df02d15e2caab0495d2876e1">doc/CONFIGURE.md</a>
(0)
</li>
<li>
<strong>R</strong>
<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458/files#diff-f415ddc943fee95d38416820f5592d2c0cd2129c84a859b961cdc6d443505041">doc/DOCKER_INSTALL.md</a>
(97)
</li>
<li>
<strong>R</strong>
<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458/files#diff-ece869a3e2064c54ae5007a46484ca1350f43eb41b3cf3ce7a95ed6e75bb2815">doc/FAQ.md</a>
(0)
</li>
<li>
<strong>A</strong>
<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458/files#diff-c60025a17472627516fb897916bc73880707de9aecab6b2f381c437fec7e8a88">doc/INSTALL.md</a>
(40)
</li>
<li>
<strong>R</strong>
<a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458/files#diff-53be6d6a523857f5ea9ce68ee29a1197c746c4d3eb9d223f4c5c9d8cc1d59c00">doc/MANUAL_INSTALL.md</a>
(137)
</li>
</ul>
<h4>Patch Links:</h4>
<ul>
<li><a href='https://github.com/openstreetmap/openstreetmap-website/pull/6458.patch'>https://github.com/openstreetmap/openstreetmap-website/pull/6458.patch</a></li>
<li><a href='https://github.com/openstreetmap/openstreetmap-website/pull/6458.diff'>https://github.com/openstreetmap/openstreetmap-website/pull/6458.diff</a></li>
</ul>
<p style="font-size:small;-webkit-text-size-adjust:none;color:#666;">—<br />Reply to this email directly, <a href="https://github.com/openstreetmap/openstreetmap-website/pull/6458">view it on GitHub</a>, or <a href="https://github.com/notifications/unsubscribe-auth/AAK2OLJZSSXXZU5JVZUT4DL3YUHMFAVCNFSM6AAAAACJWKYDY6VHI2DSMVQWIX3LMV43ASLTON2WKOZTGUZTGMJYGAZDAMA">unsubscribe</a>.<br />You are receiving this because you are subscribed to this thread.<img src="https://github.com/notifications/beacon/AAK2OLKDQ5R5CXICLAF65ET3YUHMFA5CNFSM6AAAAACJWKYDY6WGG33NNVSW45C7OR4XAZNFJFZXG5LFVJRW63LNMVXHIX3JMTHNFGANFA.gif" height="1" width="1" alt="" /><span style="color: transparent; font-size: 0; display: none; visibility: hidden; overflow: hidden; opacity: 0; width: 0; height: 0; max-width: 0; max-height: 0; mso-hide: all">Message ID: <span><openstreetmap/openstreetmap-website/pull/6458</span><span>@</span><span>github</span><span>.</span><span>com></span></span></p>
<script type="application/ld+json">[
{
"@context": "http://schema.org",
"@type": "EmailMessage",
"potentialAction": {
"@type": "ViewAction",
"target": "https://github.com/openstreetmap/openstreetmap-website/pull/6458",
"url": "https://github.com/openstreetmap/openstreetmap-website/pull/6458",
"name": "View Pull Request"
},
"description": "View this Pull Request on GitHub",
"publisher": {
"@type": "Organization",
"name": "GitHub",
"url": "https://github.com"
}
}
]</script>