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 help for quicksetup fails in intro #4838

Merged

Conversation

ramirezfranciscof
Copy link
Member

Added a clarification message suggested in a recent exchange in the mailing list.

@ramirezfranciscof
Copy link
Member Author

Last build quicklinks:

Copy link
Contributor

@csadorf csadorf left a comment

Choose a reason for hiding this comment

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

These comments are somewhat redundant since we already have an "issues? see the troubleshooting page" box at the very bottom. We could make sure that the case of "database is not auto-detected" is clearly covered there. I am therefore not fully convinced yet that we should add this at all. I'd like to see the page rendered with my suggested changes first.

docs/source/intro/install_system.rst Outdated Show resolved Hide resolved
docs/source/intro/install_system.rst Outdated Show resolved Hide resolved
docs/source/intro/install_system.rst Outdated Show resolved Hide resolved
docs/source/intro/install_conda.rst Outdated Show resolved Hide resolved
docs/source/intro/install_conda.rst Outdated Show resolved Hide resolved
docs/source/intro/install_conda.rst Outdated Show resolved Hide resolved
@ramirezfranciscof
Copy link
Member Author

ramirezfranciscof commented Mar 31, 2021

I see what you mean and I partially agree. However, note that:

  1. The "issues?" box is only at the end and inside the "Check setup" box. Although it is true that it says "or ecountered some other issue?", I think it is easy to miss if you didn't get there yet or think only has useful info if you got to that step.

  2. In the troubleshooting section I didn't find anything for what to do if you have problems with the quicksetup. I didn't find any linking to the section for manually setting up the DB either.

I'm open to other ways of addressing this issues if you prefer. For example, adding the corresponding section in the troubleshooting page and moving the troubleshooting box to the top of the installation page, after the intro text and before the tile boxes for each step.

@csadorf
Copy link
Contributor

csadorf commented Mar 31, 2021

@ramirezfranciscof I think it would be good to make sure this topic is explicitly covered on the trouble shooting page (that's an obvious place users would go when encountering problems) and then we can link directly to that section in the boxes on the installation page.

@@ -84,6 +84,8 @@ This is the recommended method for users on shared systems and systems where the
Last name: name
Institution: where-i-work

If AiiDA has any trouble autodetecting the PostgreSQL setup, you can check the optional manual setup explained in the :ref:`troubleshooting section<intro:troubleshooting:installation:quicksetup>`.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this was a misunderstanding. I did not mean to completely remove the admonition container, just its title (if possible).

Copy link
Member Author

Choose a reason for hiding this comment

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

So, I found a way to do it, but the box does not look exactly the same (the orange line where the title would be is thinner and the symbol escapes from it). Let me know if you think it is good or if I should revert to a title.

docs/source/intro/troubleshooting.rst Outdated Show resolved Hide resolved
docs/source/intro/troubleshooting.rst Outdated Show resolved Hide resolved
docs/source/intro/troubleshooting.rst Outdated Show resolved Hide resolved
docs/source/intro/troubleshooting.rst Show resolved Hide resolved
docs/source/intro/install_system.rst Outdated Show resolved Hide resolved
@ramirezfranciscof
Copy link
Member Author

Changes applied, relevant build links:

Copy link
Contributor

@csadorf csadorf left a comment

Choose a reason for hiding this comment

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

Ok, looks good. Let's just revert the work-around concerning the admonition titles and then this is good to go.

docs/source/intro/install_conda.rst Outdated Show resolved Hide resolved
docs/source/intro/install_system.rst Outdated Show resolved Hide resolved
docs/source/intro/troubleshooting.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@csadorf csadorf left a comment

Choose a reason for hiding this comment

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

LGTM!

@ramirezfranciscof ramirezfranciscof enabled auto-merge (squash) April 9, 2021 12:15
@ramirezfranciscof ramirezfranciscof merged commit 13f95ca into aiidateam:develop Apr 9, 2021
@ramirezfranciscof ramirezfranciscof deleted the docs/install_help branch February 25, 2022 16:58
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.

2 participants