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

documentation: Flask-Wiki integration #740

Merged
merged 1 commit into from
Apr 6, 2020
Merged

documentation: Flask-Wiki integration #740

merged 1 commit into from
Apr 6, 2020

Conversation

jma
Copy link
Contributor

@jma jma commented Feb 6, 2020

This new module will be used to create the public documentation
dedicated to the users and the librarians.

  • Adds Flask-Wiki dependency.
  • Adds Flask-Wiki default configuration.
  • Creates permissions to limit the wiki edition to a dedicated user.
  • Fixes bootstrap toast js and css to avoid external module collusion.
  • Moves head.html template code to the main page to be able to overwide
    the css block.
  • Includes Flask-Wiki translations.
  • Removes useless code in the Dockerfile.
  • Adds specific css for markdown figures.
  • Creates fixtures for the dev instance and for the tests.

Co-Authored-by: Johnny Mariéthoz [email protected]
Co-Authored-by: Igor Milhit [email protected]

Why are you opening this PR?

  • To implement a simple solution to create the public pages documentation.

How to test?

  • pipenv run bootstrap; pipenv run setup
  • go to the help page
  • login with the editor account account
  • create you first documentation page
  • save
  • try to upload a new image file
  • integrate this new image link in a help page

Code review check list

  • Commit message template compliance.
  • Commit message without typos.
  • File names.
  • Functions names.
  • Functions docstrings.
  • Unnecessary commited files?

@Garfield-fr Garfield-fr added this to the v0.6.0 milestone Feb 6, 2020
@jma jma removed the release label Feb 6, 2020
@jma jma force-pushed the maj-wiki branch 5 times, most recently from 5f05245 to 953c4a8 Compare February 6, 2020 14:46
@jma jma changed the title WIP documentation: Flask-Wiki integration documentation: Flask-Wiki integration Feb 6, 2020
@jma jma removed the WIP label Feb 6, 2020
@jma jma force-pushed the maj-wiki branch 5 times, most recently from 07da878 to 721f40b Compare February 10, 2020 13:26
@jma jma requested a review from iGormilhit February 10, 2020 14:14
@jma jma added the release label Feb 12, 2020
@jma jma removed the release label Feb 13, 2020
@jma jma removed this from the v0.6.0 milestone Feb 13, 2020
@jma jma force-pushed the maj-wiki branch 5 times, most recently from 192d887 to c26d8db Compare March 11, 2020 16:43
@jma jma force-pushed the maj-wiki branch 7 times, most recently from 76747e9 to 2115bf5 Compare March 12, 2020 06:31
@jma jma force-pushed the maj-wiki branch 3 times, most recently from c5947a0 to 98cfa12 Compare April 3, 2020 06:59
@jma jma requested review from blankoworld and benerken April 3, 2020 06:59
This new module will be used to create the public documentation
dedicated to the users and the librarians.

* Adds Flask-Wiki dependency.
* Adds Flask-Wiki default configuration.
* Creates permissions to limit the wiki edition to a dedicated user.
* Fixes bootstrap toast js and css to avoid external module collusion.
* Moves head.html template code to the main page to be able to overwide
the css block.
* Includes Flask-Wiki translations.
* Removes useless code in the Dockerfile.
* Adds specific css for markdown figures.
* Creates fixtures for the dev instance and for the tests.

Co-Authored-by: Johnny Mariéthoz <[email protected]>
Co-Authored-by: Igor Milhit <[email protected]>
Copy link
Contributor

@benerken benerken left a comment

Choose a reason for hiding this comment

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

In your commit message, at the point "How to test ?" , could you please add a word about the "setup" needed after the bootstrap ?
Because without a setup , the new stuff (editor role,...) are not created in the local instance. :-\
Thank you !

Copy link
Contributor

@benerken benerken left a comment

Choose a reason for hiding this comment

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

After a test, the language switch (french <-> english) doesn't work.
It stays on the french version.
Any idea ?

@jma
Copy link
Contributor Author

jma commented Apr 6, 2020

In your commit message, at the point "How to test ?" , could you please add a word about the "setup" needed after the bootstrap ?
Because without a setup , the new stuff (editor role,...) are not created in the local instance. :-
Thank you !

Oups, sorry. It is done.

@jma
Copy link
Contributor Author

jma commented Apr 6, 2020

After a test, the language switch (french <-> english) doesn't work.
It stays on the french version.
Any idea ?

Yes I works at it supposed to be. If you are in a page without suffixes (_en, _fr, etc.), it will display the page in the language interface if it is exists else the default. You can try it for the documentation root. Only english, french and default exists. The default is the fallback. But in the documentation pages the links are done explicitly in the page language i.e. in the french home page the links contains suffixes thus once you are in the sub pages you cannot switch the language unless the links are changed to default. It is up to the editor.

@jma jma merged commit e89f8fc into rero:dev Apr 6, 2020
@jma jma deleted the maj-wiki branch April 6, 2020 06:56
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.

5 participants