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.

Sign up for GitHub

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

Jump to bottom

Switch to mkdocs #381

Merged
merged 5 commits into from Mar 30, 2016
Merged

Switch to mkdocs #381

merged 5 commits into from Mar 30, 2016

Conversation

noirbizarre
Copy link
Contributor

This pull request switch from Sphinx Documentation to MkDocs so from restructuredtext to Markdown for documentation.

This is currently a work in progress because the documentaiton needs some updates !

Currently the index is extracted from #374 and both PR should be merged at some point.

davidbgk
davidbgk reviewed Mar 14, 2016
View reviewed changes
docs/configuration.md

The configuration file is simply a Python file exporting some variables.

uData use some flask extensions and so provides all avaiable options for theses extensions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

useS, avaiLable, these_

@davidbgk
Copy link
Member

Looks good so far! I think we need two entry points:

  • Quickstart with docker if you just want to test or hack visual stuff
  • Tutorial with all options, venv and so on if you want to go deeper

@noirbizarre @vinyll thoughts?

vinyll
vinyll reviewed Mar 14, 2016
View reviewed changes
docs/configuration.md

**default**: `'oauth-i18n.oauth_error'`

The OAuth2 error page. Do not modify unless you know what you do.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what you are doing

vinyll
vinyll reviewed Mar 14, 2016
View reviewed changes
docs/configuration.md

## Example configuration file

Here a sample configuration file:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is

@noirbizarre
Copy link
Contributor Author

Yep, we can split into multiple entrypoint and having a quikstart with only Docker will allow to get up and running fast.

@vinyll I will integrate you commits from #374 (minus the udata/templates/header.html part) into this one, is it OK for you ?

@noirbizarre noirbizarre mentioned this pull request Mar 14, 2016
Closed
@vinyll
Copy link
Member

vinyll commented Mar 14, 2016

@noirbizarre that's fine with me (thought the Travis crashed).
Do you want the header in another PR? That's basically one </div> removed.

@noirbizarre
Copy link
Contributor Author

@vinyll 👍 for another PR with the header

@noirbizarre
Copy link
Contributor Author

I integrated partially #374

vinyll
vinyll reviewed Mar 21, 2016
View reviewed changes
docs/configuration.md

See [the official Flask-MongoEngine documentation](https://flask-mongoengine.readthedocs.org/en/latest/)
See [the official Flask-MongoEngine documentation][flask-mongoengine-doc]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this an internal link to readthedocs? In which case it creates a hard dependency on the doc beeing read on the readthedocs website. Should we not just keep the markdown doc readable from anywhere?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No that kind of links is valid commonmark(down), they are defined at the bottom of the document.

@noirbizarre
Copy link
Contributor Author

I totally agree that the content needs refactoring:

  • a quickstart (with and without docker...)
  • tutorials
  • review the configuration section (some are missing, some are not used anymore)

This PR should serve as a base to start improving the documentation.

Now, the question is: Do we merge it now and amend it by PRs or do we only work in this branch until it's finalized ?

@noirbizarre noirbizarre merged commit 93e241d into opendatateam:master Mar 30, 2016
@noirbizarre noirbizarre deleted the mkdocs branch March 30, 2016 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@noirbizarre @davidbgk @vinyll