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 "How to manage your installation - Managing profiles" #4066

Merged

Conversation

sphuber
Copy link
Contributor

@sphuber sphuber commented May 12, 2020

Fixes #4000

This is a new section that is intended to describe the function of
profiles and the various commands that can be used to work with them.
Note that the explanation on the purpose and details of profiles is kept
to a minimum as this is a How-to guide and is merely intended to help
users with goal oriented problems.

The section quickly explains the various profile commands:

* verdi profile list
* verdi profile setdefault
* verdi profile show
* verdi profile delete

Information on how further configuration through profiles is reserved
for the next how-to section "Configuring your installation".

This is a new section that is intended to describe the function of
profiles and the various commands that can be used to work with them.
Note that the explanation on the purpose and details of profiles is kept
to a minimum as this is a How-to guide and is merely intended to help
users with goal oriented problems.

The section quickly explains the various profile commands:

    * verdi profile list
    * verdi profile setdefault
    * verdi profile show
    * verdi profile delete

Information on how further configuration through profiles is reserved
for the next how-to section "Configuring your installation".
@sphuber sphuber requested a review from csadorf May 12, 2020 15:07
@sphuber
Copy link
Contributor Author

sphuber commented May 12, 2020

@csadorf I am also working on #4001 which is the section that directly follows the one that I just have written in this PR. I am not sure yet which parts should go in which, so I propose we hold off with the review/merge until I have written the other PR as well and we review them at the same time. We might want to swap the location of certain parts.

@csadorf csadorf added the pr/on-hold PR should not be merged label May 12, 2020
@sphuber sphuber added pr/ready-for-review PR is ready to be reviewed and removed pr/on-hold PR should not be merged labels May 14, 2020
docs/source/howto/installation.rst Outdated Show resolved Hide resolved
docs/source/howto/installation.rst Outdated Show resolved Hide resolved
docs/source/howto/installation.rst Outdated Show resolved Hide resolved
docs/source/howto/installation.rst Outdated Show resolved Hide resolved
docs/source/howto/installation.rst Outdated Show resolved Hide resolved
docs/source/howto/installation.rst Show resolved Hide resolved
@@ -136,6 +136,7 @@ Welcome to AiiDA's documentation!
.. toctree::
:maxdepth: 2
:caption: Internal architecture
:hidden:
Copy link
Contributor

Choose a reason for hiding this comment

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

This change is unrelated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

True, but should be done at some point. Want me to remove it from this one?

Copy link
Contributor

Choose a reason for hiding this comment

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

It's fine.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

All done

@sphuber sphuber requested a review from csadorf May 15, 2020 16:43
@csadorf csadorf merged this pull request into aiidateam:docs-revamp May 15, 2020
@sphuber sphuber deleted the fix/4000/docs-how-to-manage-profiles branch May 15, 2020 16:55
sphuber added a commit that referenced this pull request May 15, 2020
This is a new section that is intended to describe the function of
profiles and the various commands that can be used to work with them.
Note that the explanation on the purpose and details of profiles is kept
to a minimum as this is a How-to guide and is merely intended to help
users with goal oriented problems.

The section quickly explains the various profile commands:

    * verdi profile list
    * verdi profile setdefault
    * verdi profile show
    * verdi profile delete

Information on how further configuration through profiles is reserved
for the next how-to section "Configuring your installation".
csadorf pushed a commit that referenced this pull request May 29, 2020
This is a new section that is intended to describe the function of
profiles and the various commands that can be used to work with them.
Note that the explanation on the purpose and details of profiles is kept
to a minimum as this is a How-to guide and is merely intended to help
users with goal oriented problems.

The section quickly explains the various profile commands:

    * verdi profile list
    * verdi profile setdefault
    * verdi profile show
    * verdi profile delete

Information on how further configuration through profiles is reserved
for the next how-to section "Configuring your installation".
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr/ready-for-review PR is ready to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants