English | Lietuviškai




This forum is dedicated to discussing issues related to the use and development of the Peropesis Linux operating system.

Maintaining documentation

by sskras ⌂, Lithuania, Monday, November 21, 2022, 15:57 (582 days ago)

1. If I get things correctly, this VBox script hasn't made into the User Manual yet, right?

2. I'm also interested in whether the Peropesis documentation has some original source form (eg. plain HTML files or Markdown docs).

3. And if so, is the source / history of the documentation public? No offence, just being curious. :)

4. Then if I see some typo in the docs, should I enter some bug report manually (or maybe just send a patch to you as maintainer of the source) ?

Maintaining documentation

by g, Tuesday, November 22, 2022, 17:39 (581 days ago) @ sskras

1. Hasn't been yet.
2. References are provided at the end of most chapters. This means that the documentation was written based on these sources. Also, chapters often contain the phrase, "see the man page for more information about this", which means that the documentation was also based on the man page of that program. If source is not specified, then the chapter is based on the overall experience.
3. So I guess there is no original source.
4. "...should I enter some bug report manually" could you explain?

Maintaining documentation

by sskras ⌂, Lithuania, Tuesday, November 22, 2022, 20:07 (581 days ago) @ g

Acknowledged, thanks.

By the 4th point I was unsure if it's better to write you a mail message, or just go and report here: https://peropesis.org/bugs

Maintaining documentation

by g, Wednesday, November 23, 2022, 07:52 (580 days ago) @ sskras

Thank you for explanation. Do the way you want. Thank you for your efforts in improving the quality of the content.

Question: is there currently a need to keep documentation in other giving-more-independence form, rather than in HTML file, which only one person can edit. If yes, what forms of documentation storage could be?
P.S. Others could also express their opinion.

Maintaining documentation

by sskras ⌂, Lithuania, Wednesday, November 23, 2022, 13:23 (580 days ago) @ g

No urgent need at the moment. That's just to know the current balance of power, so to say.
If I stuck upon something serious, will respond with my new ideas/suggestions. :)

Copyright © 2021-2024 Peropesis. See license terms.
E-mail: info(at)peropesis.org