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

Extend getting started instructions to obtain config-user.yml #1642

Conversation

Peter9192
Copy link
Contributor

@Peter9192 Peter9192 commented May 4, 2020

First time users that use conda to install esmvaltool might have trouble getting to the config-user file. The docs point to the config-user-example.yml on github, but for those new users it may not be clear how to download a single file from there. This should make it a little bit more accessible.

Tasks

  • [ ] Create an issue to discuss what you are going to do, if you haven't done so already (and add the link at the bottom) I figured a PR was the easiest way to explain what I wanted to do.
  • Give this pull request a descriptive title that can be used as a one line summary in a changelog
  • [ ] Make sure your code is composed of functions of no more than 50 lines and uses meaningful names for variables
  • Circle/CI tests pass. Status can be seen below your pull request. If the tests are failing, click the link to find out why.
  • Preferably Codacy code quality checks pass, however a few remaining hard to solve Codacy issues are still acceptable. Status can be seen below your pull request. If there is an error, click the link to find out why. If you suspect Codacy may be wrong, please ask by commenting.
  • [ ] Please use yamllint to check that your YAML files do not contain mistakes
  • [ ] (Only if really necessary) Add any additional dependencies needed for the diagnostic script to setup.py, esmvaltool/install/R/r_requirements.txt or esmvaltool/install/Julia/julia_requirements.txt (depending on the language of your script) and also to package/meta.yaml for conda dependencies (includes Python and others, but not R/Julia)
  • [ ] If new dependencies are introduced, check that the license is compatible with Apache2.0

First time users that use conda to install esmvaltool might have trouble getting to the config-user file. The docs point to the config-user-example.yml on github, but for those new users it may not be clear how to download a single file from there. This should make it a little bit more accessible.
Copy link
Contributor

@SarahAlidoost SarahAlidoost left a comment

@Peter9192 thanks. I replaced "save linked content" with "save as" because the latter is a common option. I could not find the option of "save linked content" in right-click. Also, I removed "left-click" because it is confusing. I think providing one way to do this is enough. Also, I reformatted the text a bit.

doc/sphinx/source/quickstart/configuration.rst Outdated Show resolved Hide resolved
Co-authored-by: SarahAlidoost <55081872+SarahAlidoost@users.noreply.github.com>
@Peter9192
Copy link
Contributor Author

Peter9192 commented May 5, 2020

Thanks @SarahAlidoost , I agree this is clearer. Can you approve?

Copy link
Contributor

@SarahAlidoost SarahAlidoost left a comment

@Peter9192 thanks. It is approved.

@mattiarighi could you please have a look and merge? thanks.

@mattiarighi mattiarighi merged commit 6c940e3 into master May 6, 2020
6 checks passed
@mattiarighi mattiarighi deleted the Extend-getting-started-instructions-to-obtain-config-user.yml branch May 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants