[TIMOB-25924] Publish new docs on Github commit
| GitHub Issue | n/a |
|---|---|
| Type | Improvement |
| Priority | None |
| Status | Open |
| Resolution | Unresolved |
| Affected Version/s | n/a |
| Fix Version/s | n/a |
| Components | n/a |
| Labels | n/a |
| Reporter | Hans Knöchel |
| Assignee | Unknown |
| Created | 2018-04-02T10:02:58.000+0000 |
| Updated | 2018-04-04T17:31:34.000+0000 |
Description
Here is another crazy idea: Looking at the Vue docs, they manage all their docs from Github already. Once a new doc change is made, it is published to their web docs. Couldn't we do the same? We have all docs available on Github and have proper linting and validation running. The "only" myth is how to publish the docs (probably from Jenkins) to our web docs. Thinking even bigger, we could do the same for our module docs that are currently pulled down manually each time the docs are made (Facebook, Map, NFC, URLSession, ..).
As it's been on my mind for a while, I think we need to split our docs out from the main repo. It might cause more of a hassle when making PRs that need to touch documentation but personally I don't see that actually being an issue long term. I think we'd be able to more easily promote contributions if the repo was more dedicated to the documentation, we'd avoid CI failures and churn related to the living in the SDK that might turn people away from making contributions, my purely subjective opinion there. We could potentially long term, remove the wiki aspect of the documentation and have a single place (and account) for people to edit problems they view in the docs. Happy to discuss this more as it's a thought I've been kicking around for a while. Since I went off tangent, contributing back to the main purpose, Ben set up a 'CI' build of the docs that was using Jenkins and publishing to GitHub pages but it's now unmaintained, we might be able to bring it back alive easily? https://github.com/appcelerator/appc-docs
I've had my mind on it too some time ago, talked with [~bimmel] about this too by having it published on a lightweight site. I love how jasmine (https://jasmine.github.io/) does it.