Skip to content

Commit

Permalink
Revert "Move profiling manual section to a new tutorials toplevel hea…
Browse files Browse the repository at this point in the history
…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)
  • Loading branch information
KristofferC authored and KristofferC committed May 20, 2024
1 parent b03de8b commit 7317b9d
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 11 deletions.
8 changes: 1 addition & 7 deletions doc/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ Manual = [
"manual/environment-variables.md",
"manual/embedding.md",
"manual/code-loading.md",
"manual/profile.md",
"manual/stacktraces.md",
"manual/performance-tips.md",
"manual/workflow-tips.md",
Expand Down Expand Up @@ -192,11 +193,6 @@ BaseDocs = [

StdlibDocs = [stdlib.targetfile for stdlib in STDLIB_DOCS]

Tutorials = [
"tutorials/profile.md",
"tutorials/external.md",
]

DevDocs = [
"Documentation of Julia's Internals" => [
"devdocs/init.md",
Expand Down Expand Up @@ -255,7 +251,6 @@ const PAGES = [
"Manual" => ["index.md", Manual...],
"Base" => BaseDocs,
"Standard Library" => StdlibDocs,
"Tutorials" => Tutorials,
# Add "Release Notes" to devdocs
"Developer Documentation" => [DevDocs..., hide("NEWS.md")],
]
Expand All @@ -266,7 +261,6 @@ const PAGES = [
"Manual" => Manual,
"Base" => BaseDocs,
"Standard Library" => StdlibDocs,
"Tutorials" => Tutorials,
"Developer Documentation" => DevDocs,
]
end
Expand Down
File renamed without changes.
4 changes: 0 additions & 4 deletions doc/src/tutorials/external.md

This file was deleted.

0 comments on commit 7317b9d

Please sign in to comment.