Revert "Move profiling manual section to a new tutorials toplevel heading (#52056)" #54374
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KristofferC
added
docs
fredrikekre
approved these changes
May 6, 2024
KristofferC
added a commit
that referenced
this pull request
May 20, 2024
…ding (#52056)" (#54374) This reverts commit 137783f. I think there are many problems with the new Tutorial toplevel section: - It should be very important since it adds a full new toplevel section (to the existing five). However, it basically does not contain anything. It was created by a somewhat arbitrary move of a manual-entry to the tutorial section as well as a single page that more or less only contains an external link. - There is a non-obvious overlap between the Manual entries and the Tutorial entries. The profiling entry was moved to tutorials but you could take more or less any other entry in the manual entry and move it as well. - The comment in #52056 (review) says > We need a proper place for tutorials so tutorial-like PRs don't get rejected and so that people can write actual tutorials content with the correct audience in mind While this might be true I don't think it is obvious at all that the manual needs to be the place where people can "dump" general tutorials about things. Right now, the Tutorial-section has more or less "unbounded scope" and it isn't clear at all what should go in there. - It has been there for 7 months without any real activity (except taking a (again somewhat arbitrary) piece of the Pkg documentation into it) so it seems it isn't really used for anything. Considering all of the above, I think it is best to go back to the status quo of 1.10 instead of "locking this in" for 1.11. (cherry picked from commit 54dc748)
KristofferC
added a commit
that referenced
this pull request
May 23, 2024
…ding (#52056)" (#54374) This reverts commit 137783f. I think there are many problems with the new Tutorial toplevel section: - It should be very important since it adds a full new toplevel section (to the existing five). However, it basically does not contain anything. It was created by a somewhat arbitrary move of a manual-entry to the tutorial section as well as a single page that more or less only contains an external link. - There is a non-obvious overlap between the Manual entries and the Tutorial entries. The profiling entry was moved to tutorials but you could take more or less any other entry in the manual entry and move it as well. - The comment in #52056 (review) says > We need a proper place for tutorials so tutorial-like PRs don't get rejected and so that people can write actual tutorials content with the correct audience in mind While this might be true I don't think it is obvious at all that the manual needs to be the place where people can "dump" general tutorials about things. Right now, the Tutorial-section has more or less "unbounded scope" and it isn't clear at all what should go in there. - It has been there for 7 months without any real activity (except taking a (again somewhat arbitrary) piece of the Pkg documentation into it) so it seems it isn't really used for anything. Considering all of the above, I think it is best to go back to the status quo of 1.10 instead of "locking this in" for 1.11. (cherry picked from commit 54dc748)
KristofferC
removed
the
backport 1.11
lazarusA
pushed a commit
to lazarusA/julia
that referenced
this pull request
Jul 12, 2024
…ding (JuliaLang#52056)" (JuliaLang#54374) This reverts commit 137783f. I think there are many problems with the new Tutorial toplevel section: - It should be very important since it adds a full new toplevel section (to the existing five). However, it basically does not contain anything. It was created by a somewhat arbitrary move of a manual-entry to the tutorial section as well as a single page that more or less only contains an external link. - There is a non-obvious overlap between the Manual entries and the Tutorial entries. The profiling entry was moved to tutorials but you could take more or less any other entry in the manual entry and move it as well. - The comment in JuliaLang#52056 (review) says > We need a proper place for tutorials so tutorial-like PRs don't get rejected and so that people can write actual tutorials content with the correct audience in mind While this might be true I don't think it is obvious at all that the manual needs to be the place where people can "dump" general tutorials about things. Right now, the Tutorial-section has more or less "unbounded scope" and it isn't clear at all what should go in there. - It has been there for 7 months without any real activity (except taking a (again somewhat arbitrary) piece of the Pkg documentation into it) so it seems it isn't really used for anything. Considering all of the above, I think it is best to go back to the status quo of 1.10 instead of "locking this in" for 1.11.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This reverts commit 137783f.
I think there are many problems with the new Tutorial toplevel section:
It should be very important since it adds a full new toplevel section (to the existing five). However, it basically does not contain anything. It was created by a somewhat arbitrary move of a manual-entry to the tutorial section as well as a single page that more or less only contains an external link.
There is a non-obvious overlap between the Manual entries and the Tutorial entries. The profiling entry was moved to tutorials but you could take more or less any other entry in the manual entry and move it as well.
The comment in Move profiling manual section to a new tutorials toplevel heading #52056 (review) says
While this might be true I don't think it is obvious at all that the manual needs to be the place where people can "dump" general tutorials about things. Right now, the Tutorial-section has more or less "unbounded scope" and it isn't clear at all what should go in there.
It has been there for 7 months without any real activity (except taking a (again somewhat arbitrary) piece of the Pkg documentation into it) so it seems it isn't really used for anything.
Considering all of the above, I think it is best to go back to the status quo of 1.10 instead of "locking this in" for 1.11.