Details
-
Improvement
-
Status: Open
-
Major
-
Resolution: Unresolved
-
None
-
None
-
None
Description
Currently Bigtop's website is simple and documentation is maintained on Wiki.
This works well in some sense, however,
- Users cannot check at a glance what kind of project they can package, test or deploy. This would not make good first impression on them.
- The documentations are not allays linked to Pull requests or other updates. It is complicated for users to trace the discussions on background.
- Some contents seems old, probably because dropping a document is difficult without discussions.
I would like to resolve the issue by dividing into small pieces, and with discussions.
- Listing user's and developer's other requests on this Jira Issue.
- Considering the table of contents (Sub task)
At least it's worth checking nowadays contents.- Writing the contents with a fixed format (.md, .rst, or so on) (Sub-Sub task)
- Considering the webpage / document generator (Sub task)
Like other apache project doing, using generators is simple and have a lot of benefits.
At least it's worth updating existing webpage and wiki through discussions.
Previous discussions at the mailing list
https://lists.apache.org/thread/zg0569qnryb8dp450pom53c3ypkd3n7p
https://lists.apache.org/thread/l2pkoq1frbbjm57mzzmqt1qtn26xfy3j