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.

Sign up for GitHub

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

Jump to bottom

☂ [Tracking] Refactor "Core libraries" umbrella topic #4610

Closed
MaryaBelanger opened this issue Feb 22, 2023 · 6 comments · Fixed by #5367
Closed

☂ [Tracking] Refactor "Core libraries" umbrella topic #4610

MaryaBelanger opened this issue Feb 22, 2023 · 6 comments · Fixed by #5367
Assignees
@MaryaBelanger
Labels
a.libraries Relating to the Dart standard libraries. e2-days Can complete in < 5 days of normal, not dedicated, work from.team Reported by Dash docs team member infra.ia Relates to the organization of pages and structuring of content meta.evaluation Need to consider what changes if any are needed meta.umbrella Collects multiple related issues p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@MaryaBelanger
Copy link
Contributor

I think the Library tour should be unpacked under the "Core libraries" umbrella in the side nav, similar to how the language tour is being unpacked.

Libraries

  • Overview
  • Libraries and visibility (from the language tour)
  • dart:core
  • dart:async
  • dart:math
  • dart:convert
  • dart:html
  • dart:io
@MaryaBelanger MaryaBelanger self-assigned this Feb 22, 2023
@parlough parlough added a.libraries Relating to the Dart standard libraries. p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. e2-days Can complete in < 5 days of normal, not dedicated, work meta.evaluation Need to consider what changes if any are needed infra.ia Relates to the organization of pages and structuring of content labels Feb 22, 2023
@parlough
Copy link
Member

parlough commented Feb 22, 2023 •
edited
Loading

@MaryaBelanger I think Libraries and visibility needs to remain in the language tour as it is more about the language functionality of libraries which is important to consider when writing any code with Dart. If anything we need to expand on the concept a little and do it much earlier. A lot of code in the tour imports other code but we never talk about what it means until way later.

@parlough parlough mentioned this issue Feb 22, 2023
Merged
10 tasks
@MaryaBelanger
Copy link
Contributor Author

@parlough I wasn't too sure about that move, so thanks for your input. I'll move it back in #4612

@mit-mit
Copy link
Member

mit-mit commented Feb 24, 2023 •
edited
Loading

Unpacking the Core Libraries > Tour page SGTM!

@atsansone atsansone changed the title The "Core libraries" umbrella [Tracking] Refactor "Core libraries" umbrella topic Apr 29, 2023
@atsansone atsansone added the st.triage.ltw Indicates Lead Tech Writer has triaged label Apr 29, 2023
@atsansone atsansone added the from.team Reported by Dash docs team member label Aug 8, 2023
@atsansone atsansone changed the title [Tracking] Refactor "Core libraries" umbrella topic ☂ [Tracking] Refactor "Core libraries" umbrella topic Aug 10, 2023
@atsansone atsansone added the meta.umbrella Collects multiple related issues label Aug 22, 2023
@parlough parlough added p2-medium Necessary but not urgent concern. Resolve when possible. and removed p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. labels Sep 30, 2023
@parlough
Copy link
Member

After recent offline discussion, I'm moving this to p2 as finishing this move would simplify future library-related work :)

@MaryaBelanger
Copy link
Contributor Author

Linking #5175 -- once the tour is deconstructed, we can fit the updated page under it's corresponding library's section

@parlough
Copy link
Member

parlough commented Oct 9, 2023

Thanks for adding that! If you plan to just hammer this out, I'll be happy to review it. It shouldn't interfere too much with my migration work, and might actually help it :)

@MaryaBelanger MaryaBelanger mentioned this issue Nov 21, 2023
Merged
parlough added a commit that referenced this issue Dec 18, 2023
@MaryaBelanger @parlough
Deconstruct library tour (#5367)
14ef584 
This PR breaks up the library tour to facilitate more content living
under "Core libraries" in the future and users being able to access what
is important to them more easily.

The change is implemented in a similar fashion to the language tour
split up. The following work was completed:

- Introduced a new top-level `/libraries` folder
- Combined the index at `/guides/libraries` and the intro to the library
tour at `/libraries/index`.
- Split each section of the library tour in to their own page
- Add each new page to the sidenav under "Core libraries"
- Add a redirector on the old page to redirect accesses to specific
headings to the correct new page and heading
- Add previous and next buttons to the various pages
- Update links across the entire website
- Add and update redirects where necessary

Fixes #4610

---------

Co-authored-by: Parker Lougheed <[email protected]>
atsansone pushed a commit to atsansone/site-www that referenced this issue Jan 26, 2024
@MaryaBelanger @parlough @atsansone
Deconstruct library tour (dart-lang#5367)
2a94b2a 
This PR breaks up the library tour to facilitate more content living
under "Core libraries" in the future and users being able to access what
is important to them more easily.

The change is implemented in a similar fashion to the language tour
split up. The following work was completed:

- Introduced a new top-level `/libraries` folder
- Combined the index at `/guides/libraries` and the intro to the library
tour at `/libraries/index`.
- Split each section of the library tour in to their own page
- Add each new page to the sidenav under "Core libraries"
- Add a redirector on the old page to redirect accesses to specific
headings to the correct new page and heading
- Add previous and next buttons to the various pages
- Update links across the entire website
- Add and update redirects where necessary

Fixes dart-lang#4610

---------

Co-authored-by: Parker Lougheed <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MaryaBelanger MaryaBelanger

Labels
a.libraries Relating to the Dart standard libraries. e2-days Can complete in < 5 days of normal, not dedicated, work from.team Reported by Dash docs team member infra.ia Relates to the organization of pages and structuring of content meta.evaluation Need to consider what changes if any are needed meta.umbrella Collects multiple related issues p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Deconstruct library tour dart-lang/site-www
4 participants
@atsansone @mit-mit @parlough @MaryaBelanger