[BGPCEP-416] Move project documentation to docs.opendaylight.org Created: 21/Mar/16  Updated: 03/Mar/19  Resolved: 16/Jan/18

Status: Verified
Project: bgpcep
Component/s: BGP
Affects Version/s: Bugzilla Migration
Fix Version/s: Bugzilla Migration

Type: Bug
Reporter: Milos Fabian Assignee: Unassigned
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: All
Platform: All

External issue ID: 5569

 Description   

Let's keep the the project documentation closer to the code. Move existing documentation from OpenDaylight wiki to Maven generated site.

First explore capabilities provided by Maven and related plugins.
Choose language for documentation writing - analyze offered possibilities.
Create a raw outline for whole documentation including a short description for each section.
Discuss a proposal with community (users/developers).
Fill up the content (as much as possible), add various reports too.

The documentation update should became mandatory part of for new feature/enhancements tasks.

 Comments   
Comment by Milos Fabian [ 22/Sep/16 ]

BGP user guide reworked: https://git.opendaylight.org/gerrit/#/c/46014/

Comment by Milos Fabian [ 24/Oct/16 ]

PCEP user guide reworked: https://git.opendaylight.org/gerrit/#/c/46755/
BMP user guide reworked: https://git.opendaylight.org/gerrit/#/c/47433/

Comment by Milos Fabian [ 25/Oct/16 ]

(In reply to Milos Fabian from comment #0)
> Let's keep the the project documentation closer to the code. Move existing
> documentation from OpenDaylight wiki to Maven generated site.
>
> First explore capabilities provided by Maven and related plugins.
> Choose language for documentation writing - analyze offered possibilities.
> Create a raw outline for whole documentation including a short description
> for each section.
> Discuss a proposal with community (users/developers).
> Fill up the content (as much as possible), add various reports too.
>
> The documentation update should became mandatory part of for new
> feature/enhancements tasks.

The http://docs.opendaylight.org should be the only source of project documentation - user guides and developers guide.

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