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: remove sphinx_cheatsheet and visual_aids #4069

Merged
merged 1 commit into from
May 14, 2020

Conversation

ramirezfranciscof
Copy link
Member

@ramirezfranciscof ramirezfranciscof commented May 13, 2020

Fixes #4034 and fixes #4033

The content of visual_aids was moved to the wiki here, the content of the sphinx_cheatsheet was just removed (the wiki already contains a link to an official reference resource). Both files are no longer in the docs.

@ramirezfranciscof ramirezfranciscof changed the title Remove sphinx_cheatsheet and visual_aids Docs: remove sphinx_cheatsheet and visual_aids May 13, 2020
@ramirezfranciscof ramirezfranciscof requested a review from csadorf May 13, 2020 12:31
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.

Great! Can you make sure that there is a link to the "Graph Easy" wiki page on the "Writing Documentation" wiki page? Otherwise I'm afraid that it will be very hard to find.

@ramirezfranciscof
Copy link
Member Author

@csadorf tis done.

@sphuber
Copy link
Contributor

sphuber commented May 13, 2020

@ramirezfranciscof I edited your OP to use the keyword "fixes" to mark which issues will be fixed by this. You can see that the word is underlined showing that Github understands that it has special meaning. There are other keywords that you can use like "closing", but the way you wrote it there won't be an automatic link created in the corresponding issues.

@csadorf csadorf merged commit 7819e61 into aiidateam:docs-revamp May 14, 2020
@sphuber sphuber deleted the docs-revamp-4034 branch May 14, 2020 08:59
This was referenced May 15, 2020
@ramirezfranciscof
Copy link
Member Author

@sphuber Hey, why did this not automatically close the corresponding issues? Did github not recognize the "fixes" correctly because they were edited in instead of being in the original OP?

@sphuber
Copy link
Contributor

sphuber commented May 15, 2020

The reason is just that it wasn't merged into develop but into docs-revamp. Github will only respect those triggers when merging into the "main" branch, which we have set to develop. I guess the philosophy is that until the fix is merged into the main branch it isn't "really" fixed. So I just do it manually for now in order to keep track of what has been done

csadorf pushed a commit that referenced this pull request May 29, 2020
Removal of the SPHINX cheat sheet and visual aids page.

Instructions for creating graphs has been moved to:
https://github.com/aiidateam/aiida-core/wiki/Graph-Easy
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.

3 participants