[jira] [Created] (IGNITE-7595) Find and switch to alternate documentation engine

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Created] (IGNITE-7595) Find and switch to alternate documentation engine

Anton Vinogradov (Jira)
Denis Magda created IGNITE-7595:
-----------------------------------

             Summary: Find and switch to alternate documentation engine
                 Key: IGNITE-7595
                 URL: https://issues.apache.org/jira/browse/IGNITE-7595
             Project: Ignite
          Issue Type: Task
            Reporter: Denis Magda
            Assignee: Prachi Garg
             Fix For: 2.5


Current readme.io documentation has many drawbacks that make the life of Ignite technical writers hard. Some of the problems are:
 * Each "version" is just a copy of the previous one. When fixing something, you have to update
all the versions.
 * No good way to review changes.
 * "Propose edit" functionality is a not suitable for review. You can only accept or reject an
edit, no way to communicate with a contributor, etc
 * There is no way to prevent Google from indexing old documentation versions. Thus, it's common to come across old doc version in a google search. 

We might consider GitHub based documentation or another approach. The discussion is here:

http://apache-ignite-developers.2346864.n4.nabble.com/Move-documentation-from-readme-io-to-GitHub-pages-td16409.html



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)