Skip to content
This repository has been archived by the owner on Mar 24, 2019. It is now read-only.

feat: improved documentation site and release process #7

Closed
wants to merge 14 commits into from
Closed

feat: improved documentation site and release process #7

wants to merge 14 commits into from

Conversation

maoo
Copy link

@maoo maoo commented Oct 23, 2018

Dear ContextData team,

as discussed in the last FDC3 PMC, I'm sending a Pull Request to enable generation of documentation within the ContextData repository, as done for the API Working Group

The current result can be demoed on http://fdc3-context-data.finos.org ; please note that this deployment is based on my fork, nothing have been altered in the github.com/FDC3/ContextData repository.

Please note that:

  • This PR is not ready to be merged (see below), though feedback and review is welcome
  • The code points to pending Pull Requests, such as https://github.com/FDC3/FDC3/pull/1 , which defines the common HTML/CSS site layout and main navigation
  • Before merging, some changes must be applied to fork-specific code pointers (see TODOs in .travis.yml)
  • Before merging, I'll squash the Git commits to cleanup the git logs
  • After merging, some changes must be applied to Travis CI settings, in order to use proper deployment keys

More info on the release and documentation publishing can be found on https://github.com/maoo/FDC3/blob/common-docs-layout/docs/README.md

Happy to adapt the PR or to ship it to any pre-master branch.

Thanks,
mao

@finos-admin
Copy link

Thank you for your pull request and welcome to our community! We require contributors to sign a Contributor License Agreement and we don't seem to have CLAs on file for these contributors to the Pull Request: (@semantic-release-bot). In order for your PR to be reviewed and merged, please follow the directions at the link above.

Project team: please do not merge this Pull Request until Foundation staff have confirmed that a CLA is in place for the new contributor(s) listed above.

If there are any questions, please don't hesitate to get in touch with our Infrastructure Support team. /CC @finos-admin

@maoo
Copy link
Author

maoo commented Oct 24, 2018

@finos-cla-bot[bot] check

@finos-admin
Copy link

The cla-bot has been summoned, and re-checked this pull request!

@rikoe
Copy link
Contributor

rikoe commented Nov 6, 2018

@maoo are we ready to update and merge this branch?

@maoo
Copy link
Author

maoo commented Nov 6, 2018

@rikoe - yes, the PR is ready. Please note that:

After the merge, I will:

  • Enable Travis CI builds for this GitHub repo
  • Switch DNS entry for fdc3-context-data.finos.org
  • Set GitHub Token, email and id on Travis Settings to authorize doc publishing

@maoo
Copy link
Author

maoo commented Nov 6, 2018

@finos-cla-bot[bot] check

@rikoe
Copy link
Contributor

rikoe commented Nov 29, 2018

@maoo we are out of date again! Can we merge after the current PRs are merged?

@maoo
Copy link
Author

maoo commented Dec 2, 2018

@rikoe - done!

@maoo
Copy link
Author

maoo commented Dec 10, 2018

@finos-cla-bot[bot] check

@maoo
Copy link
Author

maoo commented Dec 10, 2018

Closing this PR and creating a new one to avoid cla bot issues.

@maoo maoo closed this Dec 10, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants