Discussion:
[Libstoragemgmt-devel] LSM document improvement plan.
Gris Ge
2014-07-23 16:06:07 UTC
Permalink
Hi all,

I would like to summery our discuss in recent IRC meeting about improve
our documentation. Here is the TODO list:

1. Quick guide.
Merge 'URI scheme' and 'Terminology' (in short) into this document.

2. Python API user guide.
Exist but need big update.

3. C API user guide.
Use doxygen (for now).

4. LSM library developer guide.
"RunningDevel' could be a good start.

5. LSM Plugin developer guide.
Exist but need review: 'WritingPlugins'

6. Installation and packaging guide.
6.1 Install from rpm repo.
6.2 Compile and install from tarball.
6.3 Distribution Packager notes.
6.4 Weekly snapshot build rpm repo.

Feel free to make comments.
Best regards.
--
Gris Ge
Gris Ge
2014-07-23 16:18:07 UTC
Permalink
Post by Gris Ge
Hi all,
I would like to summery our discuss in recent IRC meeting about improve
1. Quick guide.
Merge 'URI scheme' and 'Terminology' (in short) into this document.
2. Python API user guide.
Exist but need big update.
3. C API user guide.
Use doxygen (for now).
4. LSM library developer guide.
"RunningDevel' could be a good start.
5. LSM Plugin developer guide.
Exist but need review: 'WritingPlugins'
6. Installation and packaging guide.
6.1 Install from rpm repo.
6.2 Compile and install from tarball.
6.3 Distribution Packager notes.
6.4 Weekly snapshot build rpm repo.
7. Future Feature.
Document feature postponed and agreed in IRC or maillist.
Post by Gris Ge
Feel free to make comments.
Best regards.
--
Gris Ge
--
Gris Ge
Loading...