Repository: incubator-apex-malhar Updated Branches: refs/heads/master da6bf541c -> 51a19e1be
APEXCORE-382 #resolve Adding new documentation steps to avoid build artifacts on in site master branch Project: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/commit/23a1b100 Tree: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/tree/23a1b100 Diff: http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/diff/23a1b100 Branch: refs/heads/master Commit: 23a1b100611da9bddce14d6b8ee6aa5c9c5b9102 Parents: 5cecce4 Author: sashadt <[email protected]> Authored: Mon Mar 14 16:35:23 2016 -0700 Committer: sashadt <[email protected]> Committed: Tue Mar 15 18:03:43 2016 -0700 ---------------------------------------------------------------------- README.md | 2 ++ docs/README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/23a1b100/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index e7e3000..c5b47d0 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ Documentation Please visit the [documentation section](http://apex.incubator.apache.org/docs.html). +Documentation build and hosting process is explained in [docs README](docs/README.md). + Discussion group -------------------- http://git-wip-us.apache.org/repos/asf/incubator-apex-malhar/blob/23a1b100/docs/README.md ---------------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..3eea1ed --- /dev/null +++ b/docs/README.md @@ -0,0 +1,45 @@ +# Apex Malhar Documentation + +Repository for Malhar docs available on http://apex.incubator.apache.org/docs.html + +Documentation is written in [Markdown](https://guides.github.com/features/mastering-markdown/) format and statically generated into HTML using [MkDocs](http://www.mkdocs.org/). All documentation is located in the [docs](docs) directory, and [mkdocs.yml](mkdocs.yml) file describes the navigation structure of the published documentation. + +## Authoring + +New pages can be added under [docs](docs) or related sub-category, and a reference to the new page must be added to the [mkdocs.yml](mkdocs.yml) file to make it availabe in the navigation. Embedded images are typically added to images folder at the same level as the new page. + +When creating or editing pages, it can be useful to see the live results, and how the documents will appear when published. Live preview feature is available by running the following command at the root of the repository: + +```bash +mkdocs serve +``` + +For additional details see [writing your docs](http://www.mkdocs.org/user-guide/writing-your-docs/) guide. + +## Site Configuration + +Guides on applying site-wide [configuration](http://www.mkdocs.org/user-guide/configuration/) and [themeing](http://www.mkdocs.org/user-guide/styling-your-docs/) are available on the MkDocs site. + +## Deployment + +Deployment is done in two steps. First all documentation is statically generatd into HTML files and then it is deployed to the apex website. For more details on how conversion to HTML works see [MkDocs documentation](http://www.mkdocs.org/). + +1. Go to release branch of the repository and execute the following command to build the docs: + +```bash +# set project version +APEX_MALHAR_VERSION=3.4 + +# build docs under site foolder +mkdocs build --clean + +# copy docs from site into target folder on apex-site +cd ../incubator-apex-site +git checkout asf-site +cp -r ../incubator-apex-malhar/site docs/malhar-${APEX_MALHAR_VERSION} +git add -A +git commit -m "Adding apex-${APEX_MALHAR_VERSION} documentation" +git push +``` + +2. Go to [apex-site repository](https://github.com/apache/incubator-apex-site#contributing) and add the new link to the [docs.md](https://github.com/apache/incubator-apex-site/blob/master/src/md/docs.md) and follow committer steps to commit and push these changes, and deploy the site.
