-
Notifications
You must be signed in to change notification settings - Fork 189
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
DOCS: add help for quicksetup fails in intro #4838
Conversation
a092f57
to
16a26fc
Compare
Last build quicklinks:
|
There was a problem hiding this 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.
I see what you mean and I partially agree. However, note that:
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. |
@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. |
docs/source/intro/install_conda.rst
Outdated
@@ -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>`. |
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
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.
Co-authored-by: Carl Simon Adorf <[email protected]>
Co-authored-by: Carl Simon Adorf <[email protected]>
c30ff2d
to
766e1b8
Compare
Changes applied, relevant build links:
|
There was a problem hiding this 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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Added a clarification message suggested in a recent exchange in the mailing list.