https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/DOCS-69 docs <p>All projects should manage their own docs in a docs/ dir in their repo, vs having docs in main docs project. The main docs project should just be a curated collection of pointers.</p> DOCS-69

Move project docs to per-project docs/ dir

Improvement Medium Resolved Done Thanh Ha (zxiiro) Daniel Farrell Tue, 10 Apr 2018 19:46:22 +0000 Tue, 13 Apr 2021 15:29:51 +0000 Tue, 13 Apr 2021 15:21:31 +0000 Aluminium 1 4 <p>Went through and removed submodules for all projects that were listed in master but did not have any docs. Many of these projects originally were added due to javasphinx work but since we backed out of that it's safe to remove them.</p> <p>HI Thanh Ha,</p> <p>I raised one patch for OVSDB, can please provide rtd-build-url and rtd-token for ovsdb project.</p> <p>Patches are here</p> <p><a href="https://git.opendaylight.org/gerrit/#/c/71829/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/71829/</a></p> <p><a href="https://git.opendaylight.org/gerrit/#/c/71831/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/71831/</a></p> <p> </p> <p>-Nobin</p> <p>Hi <a href="https://jira.opendaylight.org/secure/ViewProfile.jspa?name=cloudy" class="user-hover" rel="cloudy">cloudy</a>,</p> <p>I'm currently on PTO and won't be back for 2 weeks (The week of May 21st) and will be losing Internet access shortly.</p> <p>To setup a project in ReadTheDocs follow instructions here:</p> <p><a href="http://docs.releng.linuxfoundation.org/en/latest/project-documentation.html#add-a-project-to-readthedocs" class="external-link" target="_blank" rel="nofollow noopener">http://docs.releng.linuxfoundation.org/en/latest/project-documentation.html#add-a-project-to-readthedocs</a></p> <p>(Don't forget to add lf-rtd as a maintainer)</p> <p>Once that's complete, you can follow details here (Refer to step 3):</p> <p><a href="http://docs.releng.linuxfoundation.org/en/latest/project-documentation.html" class="external-link" target="_blank" rel="nofollow noopener">http://docs.releng.linuxfoundation.org/en/latest/project-documentation.html</a></p> <p>This should get you setup with the rtd-build-url and rtd-token.</p> <p>Hope this helps,<br/> Thanh</p> <p><a href="https://jira.opendaylight.org/secure/ViewProfile.jspa?name=cloudy" class="user-hover" rel="cloudy">cloudy</a> et al, I can try to help with any RTDs questions/issues while Thanh is on PTO.</p> <p>HI Daniel,</p> <p>Will you be able to help in step 7 in <a href="http://docs.releng.linuxfoundation.org/en/latest/project-documentation.html#add-a-project-to-readthedocs" class="external-link" target="_blank" rel="nofollow noopener">http://docs.releng.linuxfoundation.org/en/latest/project-documentation.html#add-a-project-to-readthedocs</a>, i.e. adding a subproject for ovsdb?.</p> <p> </p> <p>-Nobin</p> <p> </p> <p> </p> <p>Nope, you'll need to email the helpdesk about that one.</p> <p>Nobin: </p> <p>I have made some minor edit to your change and also cherry-picked to other branches.</p> <p><a href="https://git.opendaylight.org/gerrit/71900" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/71900</a><br/> <a href="https://git.opendaylight.org/gerrit/71899" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/71899</a></p> <p>Sorry for the delay. I have setup the subproject link. You should be good to go now.</p> <p>Regards,<br/> Thanh</p> <p>Patches have now been proposed to all submodule projects of docs. Once merged we can remove submodules from the docs project and then focus on migrating projects that have docs inside of the docs project out.</p> <p>Submitted patches to all projects that have a project-indexes.</p> Development Rank 0|i03d4v: