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

Minimum upgrade of the builds docs #5398

Merged
merged 4 commits into from Mar 5, 2019
Merged

Minimum upgrade of the builds docs #5398

merged 4 commits into from Mar 5, 2019

Conversation

@humitos
Copy link
Member

@humitos humitos commented Mar 5, 2019

  • Removed a code example section that does not reflects what exactly happens anymore
  • Replace the mention to options from the Admin UI for the config V2 file
  • More specific on the limits
@humitos humitos requested a review from Mar 5, 2019
@humitos humitos force-pushed the humitos/update-builds-docs branch from c83f65b to ed15959 Mar 5, 2019
Copy link
Member

@ericholscher ericholscher left a comment

Good updates. I think it's useful to explain to the user more how builds work though, not just delete that information.

docs/builds.rst Outdated
if project.requirements_file:
run('pip install -r %s' % project.requirements_file)
build_docs(version=version)
copy_files(artifact_dir)
Copy link
Member

@ericholscher ericholscher Mar 5, 2019

I wonder if we should still include some updated version of this. I think it's useful for users to get a mental model of what's happening.

Copy link
Member Author

@humitos humitos Mar 5, 2019

I thought about this, but I came up that it was more complicated to explain in code now considering that we have many options on our config file. In the end, I seemed to me to be more confusing than clarifying.

What about this? I tried to keep some consistency with YAML options.

    update_docs_from_vcs(version)
    config = get_config(project)
    if config.python.install.method.setuptools:
        run('python setup.py install')
    if config.python.install.method.pip:
        run('pip install .')
    if config.python.install.requirement:
        run('pip install -r %s' % config.python.install.requirement)
    build_docs(version=version)
    copy_files(artifact_dir)

It's not 100% accurate, but maybe it's better than removing it. What do you think?

Copy link
Member

@ericholscher ericholscher Mar 5, 2019

Looks good to me. 👍

@humitos humitos force-pushed the humitos/update-builds-docs branch from dffb58c to a1e33af Mar 5, 2019
@humitos humitos requested a review from ericholscher Mar 5, 2019
@humitos humitos merged commit 0917fbd into master Mar 5, 2019
1 check passed
@delete-merged-branch delete-merged-branch bot deleted the humitos/update-builds-docs branch Mar 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants