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

docs: Add pip version and dockertag as parameter in the build process #1560

Merged
merged 8 commits into from Jun 21, 2022

Conversation

dcfidalgo
Copy link
Contributor

This PR adds automatic substitutions of pip versions and docker tags in rst files. But I did not manage to make it work for the user-management.ipynb notebook. I propose to move the content of this notebook to a rst or md file, since there is not too much code.
@frascuchon should I proceed, or should I keep trying to make it also work for notebooks?

@dcfidalgo dcfidalgo self-assigned this Jun 13, 2022
@dcfidalgo dcfidalgo added the type: documentation Improvements or additions to documentation label Jun 13, 2022
@dcfidalgo dcfidalgo added this to In progress in Release via automation Jun 13, 2022
Copy link
Member

@frascuchon frascuchon left a comment

Choose a reason for hiding this comment

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

Go ahead with the .rst transformation for the user management tutorial.

docs/getting_started/setup&installation.rst Outdated Show resolved Hide resolved
docs/getting_started/setup&installation.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
@dcfidalgo dcfidalgo force-pushed the docs/add_release_parameter_to_docs branch from 0e46212 to 1ba1199 Compare June 14, 2022 11:53
docs/getting_started/user-management.md Outdated Show resolved Hide resolved
docs/getting_started/user-management.md Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/getting_started/advanced_setup_guides.md Outdated Show resolved Hide resolved
Co-authored-by: Francisco Aranda <francisco@recogn.ai>
Release automation moved this from In progress to Review OK Jun 17, 2022
@dcfidalgo dcfidalgo merged commit 477f4fe into master Jun 21, 2022
Release automation moved this from Review OK to Waiting Release Jun 21, 2022
@dcfidalgo dcfidalgo deleted the docs/add_release_parameter_to_docs branch June 21, 2022 13:52
@frascuchon frascuchon moved this from Waiting Release to Ready to Release QA in Release Jul 6, 2022
frascuchon added a commit that referenced this pull request Jul 6, 2022
…#1560)

* substitute pipversion and dockertag

* move setup guide to markdown

* remove dependency

* move index to md

* move advanced setup guides to md

* move user-management to md

* add substitutions

* Apply suggestions from code review

Co-authored-by: Francisco Aranda <francisco@recogn.ai>

Co-authored-by: Francisco Aranda <francisco@recogn.ai>
(cherry picked from commit 477f4fe)
@frascuchon frascuchon moved this from Ready to Release QA to Approved Release QA in Release Jul 7, 2022
frascuchon added a commit that referenced this pull request Jul 8, 2022
…#1560)

* substitute pipversion and dockertag

* move setup guide to markdown

* remove dependency

* move index to md

* move advanced setup guides to md

* move user-management to md

* add substitutions

* Apply suggestions from code review

Co-authored-by: Francisco Aranda <francisco@recogn.ai>

Co-authored-by: Francisco Aranda <francisco@recogn.ai>
(cherry picked from commit 477f4fe)
frascuchon added a commit that referenced this pull request Jul 8, 2022
…#1560)

* substitute pipversion and dockertag

* move setup guide to markdown

* remove dependency

* move index to md

* move advanced setup guides to md

* move user-management to md

* add substitutions

* Apply suggestions from code review

Co-authored-by: Francisco Aranda <francisco@recogn.ai>

Co-authored-by: Francisco Aranda <francisco@recogn.ai>
(cherry picked from commit 477f4fe)
frascuchon added a commit that referenced this pull request Jul 8, 2022
…#1560)

* substitute pipversion and dockertag

* move setup guide to markdown

* remove dependency

* move index to md

* move advanced setup guides to md

* move user-management to md

* add substitutions

* Apply suggestions from code review

Co-authored-by: Francisco Aranda <francisco@recogn.ai>

Co-authored-by: Francisco Aranda <francisco@recogn.ai>
(cherry picked from commit 477f4fe)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Improvements or additions to documentation
Projects
No open projects
Release
Approved Release QA
Development

Successfully merging this pull request may close these issues.

None yet

2 participants