#49991 Improve man page and server docs
Closed: wontfix 3 years ago by spichugi. Opened 5 years ago by firstyear.

Issue Description

It's common to hear from people that our "non-redhat' docs are lacking, and that often the RH docs are console focused. We should improve this situation. I think we should invest some time in sphinx and read the docs, given that this can also emit man pages for the project.

Making it easier to generate and update man pages and docs will be important if we can ship useful and complete documentation with the package to make the software more accessible.


Additionally, an extension of this could be that the server's design document section could be part of this, and then can be reviewed, commented, PRed in the same manner as our code.

Metadata Update from @firstyear:
- Custom field component adjusted to None
- Custom field origin adjusted to None
- Custom field reviewstatus adjusted to None
- Custom field type adjusted to None
- Custom field version adjusted to None

5 years ago

Metadata Update from @mreynolds:
- Issue set to the milestone: 1.4.2

5 years ago

Metadata Update from @vashirov:
- Issue set to the milestone: 1.4 backlog (was: 1.4.2)

4 years ago

389-ds-base is moving from Pagure to Github. This means that new issues and pull requests
will be accepted only in 389-ds-base's github repository.

This issue has been cloned to Github and is available here:
- https://github.com/389ds/389-ds-base/issues/3050

If you want to receive further updates on the issue, please navigate to the github issue
and click on subscribe button.

Thank you for understanding. We apologize for all inconvenience.

Metadata Update from @spichugi:
- Issue close_status updated to: wontfix
- Issue status updated to: Closed (was: Open)

3 years ago

Login to comment on this ticket.

Metadata