[DOCS-69] Move project docs to per-project docs/ dir Created: 10/Apr/18  Updated: 13/Apr/21  Resolved: 13/Apr/21

Status: Resolved
Project: docs
Component/s: None
Affects Version/s: None
Fix Version/s: Aluminium

Type: Improvement Priority: Medium
Reporter: Daniel Farrell Assignee: Thanh Ha (zxiiro)
Resolution: Done Votes: 1
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

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.



 Comments   
Comment by Thanh Ha (zxiiro) [ 01/May/18 ]

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.

Comment by Nobin Mathew [ 07/May/18 ]

HI Thanh Ha,

I raised one patch for OVSDB, can please provide rtd-build-url and rtd-token for ovsdb project.

Patches are here

https://git.opendaylight.org/gerrit/#/c/71829/

https://git.opendaylight.org/gerrit/#/c/71831/

 

-Nobin

Comment by Thanh Ha (zxiiro) [ 07/May/18 ]

Hi cloudy,

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.

To setup a project in ReadTheDocs follow instructions here:

http://docs.releng.linuxfoundation.org/en/latest/project-documentation.html#add-a-project-to-readthedocs

(Don't forget to add lf-rtd as a maintainer)

Once that's complete, you can follow details here (Refer to step 3):

http://docs.releng.linuxfoundation.org/en/latest/project-documentation.html

This should get you setup with the rtd-build-url and rtd-token.

Hope this helps,
Thanh

Comment by Daniel Farrell [ 07/May/18 ]

cloudy et al, I can try to help with any RTDs questions/issues while Thanh is on PTO.

Comment by Nobin Mathew [ 07/May/18 ]

HI Daniel,

Will you be able to help in step 7 in http://docs.releng.linuxfoundation.org/en/latest/project-documentation.html#add-a-project-to-readthedocs, i.e. adding a subproject for ovsdb?.

 

-Nobin

 

 

Comment by Daniel Farrell [ 07/May/18 ]

Nope, you'll need to email the helpdesk about that one.

Comment by Anil Belur [ 10/May/18 ]

Nobin:

I have made some minor edit to your change and also cherry-picked to other branches.

https://git.opendaylight.org/gerrit/71900
https://git.opendaylight.org/gerrit/71899

Comment by Thanh Ha (zxiiro) [ 03/Jun/18 ]

Sorry for the delay. I have setup the subproject link. You should be good to go now.

Regards,
Thanh

Comment by Thanh Ha (zxiiro) [ 03/Jun/18 ]

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.

Comment by Thanh Ha (zxiiro) [ 09/Sep/18 ]

Submitted patches to all projects that have a project-indexes.

Generated at Wed Feb 07 19:58:35 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.