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

☂️ Migrate embedded DartPads away from multifile #5382

Closed
8 tasks done
parlough opened this issue Nov 30, 2023 · 1 comment · Fixed by #5552
Closed
8 tasks done

☂️ Migrate embedded DartPads away from multifile #5382

parlough opened this issue Nov 30, 2023 · 1 comment · Fixed by #5552
Assignees
@parlough @MaryaBelanger
Labels
a.tut.codelab Relates to codelabs hosted on dart.dev. e3-weeks Complete in < 4 weeks of normal, not dedicated, work from.team Reported by Dash docs team member infra.dartpad Relates to DartPad component code or functionality meta.umbrella Collects multiple related issues p1-high Major but not urgent concern: Resolve in months. Update each month. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@parlough
Copy link
Member

parlough commented Nov 30, 2023 •
edited
Loading

To prepare for DartPad no longer supporting multi-file and related features (tests, solutions, hints), we need to update, migrate, or remove the following content.

Codelabs

The should either be updated to be useful without the testing capability, consolidated with other material elsewhere, or just removed for now.

Low-level HTML tutorials

These will be replaced by new package:web and static interop docs, so we likely don't need to worry about them too much. If we move to the new DartPad before they are replaced, dropping the embedded DartPads from the page is fine.

Misc
@parlough parlough added p1-high Major but not urgent concern: Resolve in months. Update each month. e3-weeks Complete in < 4 weeks of normal, not dedicated, work infra.dartpad Relates to DartPad component code or functionality a.tut.codelab Relates to codelabs hosted on dart.dev. labels Nov 30, 2023
@parlough parlough mentioned this issue Nov 30, 2023
Merged
@parlough parlough added the from.team Reported by Dash docs team member label Dec 1, 2023
@parlough
Copy link
Member Author

parlough commented Dec 1, 2023

\cc @johnpryan I removed the remaining uses of multi-page and testing functionality from the Flutter website, but it will take more work on the Dart website. I've outlined the remaining usages and my thoughts about potential next steps. Let me know any thoughts you have :)

@MaryaBelanger MaryaBelanger mentioned this issue Dec 5, 2023
Merged
@johnpryan johnpryan mentioned this issue Dec 6, 2023
Closed
parlough added a commit that referenced this issue Dec 8, 2023
@parlough
Remove DartPad tutorial best practices (#5383)
b6cb885 
Support for tests/solutions/hints/etc (at least in their current form)
is going away soon in embedded DartPads, so I don't think we should be
surfacing guidelines on how to best use them.

This PR removes that page and redirects to an underlying paper which
publishes some of the same findings.

Contributes to #5382
@parlough parlough mentioned this issue Dec 19, 2023
Merged
parlough added a commit that referenced this issue Dec 21, 2023
@parlough @MaryaBelanger
Remove low-level HTML tutorials and add redirects (#5415)
57857f5 
These tutorials are heavily built around multi-file DartPad support
which is going away and web programming will be changing greatly with
`package:web` and static interop in the future. Due to the low views
these pages get, this PR proposes removing them for now rather than
restructuring them for their short remaining time to live. Reducing our
maintenance costs and unblocking the DartPad work.

Contributes to #5382 and
#4331

We can always revive these pages from Git history if needed or desired
:)

---------

Co-authored-by: Marya <[email protected]>
parlough added a commit that referenced this issue Dec 22, 2023
@MaryaBelanger @parlough
Remove multi-file DartPad usages from cheatsheet (#5392)
0d27b4f 
Part of #5382 

- The tests feature contained `main` for each example, but that features
being removed. The examples need `main` to run, and also are not helpful
without the feedback that the tests provided, so we're adding the tests
to code visible in each dartpad.
  - Comment at the top of each that this part is tests, don't edit
  - Will have to adjust the tests for more useful messages to users. 
- Since `main` is a big focus now, add a new section on the `main`
function at the top of the cheatsheet.

- Also remove hint and solution feature and place in expandable
"solution" section under each example.

- Rewrite the intro section to explain the new way the page works.

---------

Co-authored-by: Parker Lougheed <[email protected]>
atsansone pushed a commit to atsansone/site-www that referenced this issue Jan 26, 2024
@parlough @atsansone
Remove DartPad tutorial best practices (dart-lang#5383)
581d2bf 
Support for tests/solutions/hints/etc (at least in their current form)
is going away soon in embedded DartPads, so I don't think we should be
surfacing guidelines on how to best use them.

This PR removes that page and redirects to an underlying paper which
publishes some of the same findings.

Contributes to dart-lang#5382
atsansone pushed a commit to atsansone/site-www that referenced this issue Jan 26, 2024
@parlough @MaryaBelanger @atsansone
Remove low-level HTML tutorials and add redirects (dart-lang#5415)
1270b63 
These tutorials are heavily built around multi-file DartPad support
which is going away and web programming will be changing greatly with
`package:web` and static interop in the future. Due to the low views
these pages get, this PR proposes removing them for now rather than
restructuring them for their short remaining time to live. Reducing our
maintenance costs and unblocking the DartPad work.

Contributes to dart-lang#5382 and
dart-lang#4331

We can always revive these pages from Git history if needed or desired
:)

---------

Co-authored-by: Marya <[email protected]>
atsansone pushed a commit to atsansone/site-www that referenced this issue Jan 26, 2024
@MaryaBelanger @parlough @atsansone
Remove multi-file DartPad usages from cheatsheet (dart-lang#5392)
9dc938e 
Part of dart-lang#5382 

- The tests feature contained `main` for each example, but that features
being removed. The examples need `main` to run, and also are not helpful
without the feedback that the tests provided, so we're adding the tests
to code visible in each dartpad.
  - Comment at the top of each that this part is tests, don't edit
  - Will have to adjust the tests for more useful messages to users. 
- Since `main` is a big focus now, add a new section on the `main`
function at the top of the cheatsheet.

- Also remove hint and solution feature and place in expandable
"solution" section under each example.

- Rewrite the intro section to explain the new way the page works.

---------

Co-authored-by: Parker Lougheed <[email protected]>
@atsansone atsansone added st.triage.ltw Indicates Lead Tech Writer has triaged meta.umbrella Collects multiple related issues labels Feb 13, 2024
This was referenced Feb 13, 2024
Merged
Merged
Merged
parlough added a commit that referenced this issue Feb 14, 2024
@parlough
Migrate iterables codelab away from multi-file (#5542)
9a824ff 
- Removes usage of multi-file DartPad support (tests, hints, solutions)
- Introduces new separate **Hint** and **Solution** details-based
dropdowns

Contributes to #5382
parlough added a commit that referenced this issue Feb 14, 2024
@parlough
Add custom styles for details-based dropdowns (#5545)
096e43a 
Adds interaction styles and spacing to the details summary as well as
spacing to the contents.

An example of how this effects on a details usage on hover at `/language/isolates#complete-example`:

<img width="984" alt="Hovering over the summary of a details dropdown"
src="https://github.com/dart-lang/site-www/assets/18372958/8264ff11-cbea-4d51-8de2-f38b21b9a4e9">


Contributes to #5382 which
will use `<details>` as a replacement in some cases.
@parlough parlough mentioned this issue Feb 14, 2024
Merged
parlough added a commit that referenced this issue Feb 14, 2024
@parlough
Migrate async/await codelab away from multi-file (#5544)
26898a5 
Contributes to #5382
parlough added a commit that referenced this issue Feb 14, 2024
@parlough
Remove null safety codelab for now (#5539)
3ded6cb 
Removes the null safety codelab and references to it. In a few days, I
will follow up soon with some new samples on the cheatsheet to replace
this.

This codelab is the least viewed on the site and no longer makes sense
to separate from other language learning. As mentioned, I will follow up
with a few new samples on the cheatsheet as a stop-gap until we
implement a consolidated new-learner experience.

Contributes to #5382
Contributes to #4603
Closes #3093
@parlough parlough mentioned this issue Feb 15, 2024
Merged
parlough added a commit that referenced this issue Feb 15, 2024
@parlough
Finalize cleanup of features relying on old DartPad (#5552)
7a4480d 
- Introduces how to use the exercises on the async await and iterables
codelab pages
- Updates some mentions of already removed DartPad features (old
channel, HTML, etc)
- Replaces "Try Dart" embedded DartPad that's on homepage with simple
embed
- For now, it can rely on the samples present in the DartPad UI, which
we plan to add to
  - Can revisit custom examples in the future.
- A bit of a loss, but the current ones don't show Dart's newest, most
powerful futures anyway
  
Closes #5382
Closes #2578
atsansone pushed a commit to atsansone/site-www that referenced this issue Feb 20, 2024
@parlough @atsansone
Migrate iterables codelab away from multi-file (dart-lang#5542)
c459ca3 
- Removes usage of multi-file DartPad support (tests, hints, solutions)
- Introduces new separate **Hint** and **Solution** details-based
dropdowns

Contributes to dart-lang#5382
atsansone pushed a commit to atsansone/site-www that referenced this issue Feb 20, 2024
@parlough @atsansone
Add custom styles for details-based dropdowns (dart-lang#5545)
36c939c 
Adds interaction styles and spacing to the details summary as well as
spacing to the contents.

An example of how this effects on a details usage on hover at `/language/isolates#complete-example`:

<img width="984" alt="Hovering over the summary of a details dropdown"
src="https://github.com/dart-lang/site-www/assets/18372958/8264ff11-cbea-4d51-8de2-f38b21b9a4e9">


Contributes to dart-lang#5382 which
will use `<details>` as a replacement in some cases.
atsansone pushed a commit to atsansone/site-www that referenced this issue Feb 20, 2024
@parlough @atsansone
Migrate async/await codelab away from multi-file (dart-lang#5544)
3e116b4 
Contributes to dart-lang#5382
atsansone pushed a commit to atsansone/site-www that referenced this issue Feb 20, 2024
@parlough @atsansone
Remove null safety codelab for now (dart-lang#5539)
aa1d57e 
Removes the null safety codelab and references to it. In a few days, I
will follow up soon with some new samples on the cheatsheet to replace
this.

This codelab is the least viewed on the site and no longer makes sense
to separate from other language learning. As mentioned, I will follow up
with a few new samples on the cheatsheet as a stop-gap until we
implement a consolidated new-learner experience.

Contributes to dart-lang#5382
Contributes to dart-lang#4603
Closes dart-lang#3093
atsansone pushed a commit to atsansone/site-www that referenced this issue Mar 22, 2024
@parlough @atsansone
Migrate iterables codelab away from multi-file (dart-lang#5542)
a9255ce 
- Removes usage of multi-file DartPad support (tests, hints, solutions)
- Introduces new separate **Hint** and **Solution** details-based
dropdowns

Contributes to dart-lang#5382
atsansone pushed a commit to atsansone/site-www that referenced this issue Mar 22, 2024
@parlough @atsansone
Add custom styles for details-based dropdowns (dart-lang#5545)
74e5c2c 
Adds interaction styles and spacing to the details summary as well as
spacing to the contents.

An example of how this effects on a details usage on hover at `/language/isolates#complete-example`:

<img width="984" alt="Hovering over the summary of a details dropdown"
src="https://github.com/dart-lang/site-www/assets/18372958/8264ff11-cbea-4d51-8de2-f38b21b9a4e9">


Contributes to dart-lang#5382 which
will use `<details>` as a replacement in some cases.
atsansone pushed a commit to atsansone/site-www that referenced this issue Mar 22, 2024
@parlough @atsansone
Migrate async/await codelab away from multi-file (dart-lang#5544)
8c90e5b 
Contributes to dart-lang#5382
atsansone pushed a commit to atsansone/site-www that referenced this issue Mar 22, 2024
@parlough @atsansone
Remove null safety codelab for now (dart-lang#5539)
42150d2 
Removes the null safety codelab and references to it. In a few days, I
will follow up soon with some new samples on the cheatsheet to replace
this.

This codelab is the least viewed on the site and no longer makes sense
to separate from other language learning. As mentioned, I will follow up
with a few new samples on the cheatsheet as a stop-gap until we
implement a consolidated new-learner experience.

Contributes to dart-lang#5382
Contributes to dart-lang#4603
Closes dart-lang#3093
atsansone pushed a commit to atsansone/site-www that referenced this issue Mar 22, 2024
@parlough @atsansone
Finalize cleanup of features relying on old DartPad (dart-lang#5552)
761224b 
- Introduces how to use the exercises on the async await and iterables
codelab pages
- Updates some mentions of already removed DartPad features (old
channel, HTML, etc)
- Replaces "Try Dart" embedded DartPad that's on homepage with simple
embed
- For now, it can rely on the samples present in the DartPad UI, which
we plan to add to
  - Can revisit custom examples in the future.
- A bit of a loss, but the current ones don't show Dart's newest, most
powerful futures anyway
  
Closes dart-lang#5382
Closes dart-lang#2578
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@parlough parlough

@MaryaBelanger MaryaBelanger

Labels
a.tut.codelab Relates to codelabs hosted on dart.dev. e3-weeks Complete in < 4 weeks of normal, not dedicated, work from.team Reported by Dash docs team member infra.dartpad Relates to DartPad component code or functionality meta.umbrella Collects multiple related issues p1-high Major but not urgent concern: Resolve in months. Update each month. 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.

Finalize cleanup of features relying on old DartPad dart-lang/site-www
3 participants
@atsansone @parlough @MaryaBelanger