Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

html_of_wiki and Travis CI (orphan branch) #231

Merged
merged 2 commits into from
Dec 19, 2018
Merged

Conversation

leovalais
Copy link

Following #230, wikidoc is an on orphan branch.

I wouldn't mind an explanation of the CI workflow that will be used

Travis allows multiple configuration files. The CI will run for each commit (and merge commit) on wikidoc. It automatically downloads and setup html_of_wiki and generates the HTML pages based on the branch's content. I've already setup the configuration for html_of_wiki for this project.
Then, only on the wikidoc branch, it deploys the content to github pages. Thus the CI on master (and its forked branches) is unchanged.

Part of the documentation (still a WIP) of html_of_wiki can be found at http://ocsigen.org/html_of_wiki/2.0/manual/intro

@leovalais leovalais self-assigned this Dec 19, 2018
@leovalais leovalais requested review from balat and Drup December 19, 2018 17:19
@Drup
Copy link
Member

Drup commented Dec 19, 2018

Good!

It's still not clear to me how you generate the API doc and push the resulting .wiki files to docs/dev/. Also, I would like to know the exact things I need to do when drafting a new release (which should be documented here), but you can clarify all that later.

@Drup Drup merged commit 9e8314a into wikidoc Dec 19, 2018
@Drup Drup deleted the wikidoc-orphan-wip branch December 19, 2018 19:03
@Drup
Copy link
Member

Drup commented Dec 19, 2018

Quick feedback on the documentation tooling

  1. Just make one single tool with multiple "verbs" (like git/opam) instead of playing clever games with acronyms.
  2. Since you seem to be working on the general tooling: keep in mind that the ultimate goal (might be in the long term, but still) is to use odoc for everything instead. So everything that you do not implement and replace by externally maintained things is a net plus.

@Drup
Copy link
Member

Drup commented Dec 19, 2018

@leovalais
Copy link
Author

Thanks for the feedback!

Just make one single tool with multiple "verbs" (like git/opam) instead of playing clever games with acronyms.

It is what is planned (ocsigen/html_of_wiki#108) but I don't think I will have enough to finish that properly before the end of my internship at BeSport. So I wrote the two scripts (the dop and quickdop things) in order to have it at least working in a CI. But you're absolutely right, it is not convenient at all.

So everything that you do not implement and replace by externally maintained things is a net plus.

I know that html_of_wiki will eventually be replaced by odoc (for the better), but in the short term at least, there's still the need of a tool to deal with the existing documentation. I tried to keep it as simple as possible (just enough for the ocsigen projects).

@leovalais
Copy link
Author

@leovalais Issue in the build it seems : https://travis-ci.org/ocsigen/tyxml/builds/470166584?utm_medium=notification&utm_source=email

A Github access token was missing. I restarted the build: it should work properly now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants