Official User Guide's format and repository

Contribute ideas for future releases.
Forum rules
No support questions here please.
Suggestion & new ideas for Cinnamon go on GitHub.

Official User Guide's format and repository

Postby ayanokouzi on Fri Jun 08, 2012 11:05 pm

Dear Sir or Madam,

Here I would like to suggest changing the format of official user
guide from OpenDocument Text (odt) to SOMETHING more comfortable to
check an update and to providing an official concurrent versions
system repository for the user guide.

I've translated some sections of official user guide into Japanese
and I find that odt format have following essential problems.

1. It is difficult to check updates and history on original text.
2. there is no convenient way to commit an improvement to original
text with authentication.

If new format is similar to plain text (like xml, ...), in combination
with any version control system (like cvs, svn, git, ...), people,
especially translators, can find which part is updated. And by using
any version control system, people can contribute with his
own authentication.

Specifically, I would like to suggest using "publican" [1] for writing
and building user guide. PO format for translation, Git version control
system for convenient-committing.

[1] https://fedorahosted.org/publican/

Regards,
AYANOKOUZI, Ryuunosuke
--
AYANOKOUZI, Ryuunosuke <i38w7i3@yahoo.co.jp>
ayanokouzi
Level 1
Level 1
 
Posts: 7
Joined: Fri Jun 08, 2012 9:27 pm

Linux Mint is funded by ads and donations.
 

Return to Suggestions & New Ideas

Who is online

Users browsing this forum: xenopeek and 5 guests