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

Remove reliance on Docker and migrate away from Jekyll #10203

Closed
parlough opened this issue Feb 26, 2024 · 2 comments · Fixed by #10336
Closed

Remove reliance on Docker and migrate away from Jekyll #10203

parlough opened this issue Feb 26, 2024 · 2 comments · Fixed by #10336
Assignees
@parlough
Labels
e3-weeks Effort: < 4 weeks from.team Reported by Dash docs team member infra.design Relates to the design of docs.flutter.dev infra.structure Relates to the tools that create docs.flutter.dev p1-high Major but not urgent concern: Resolve in months. Update each month.

Comments

@parlough
Copy link
Member

No description provided.

@parlough parlough added infra.structure Relates to the tools that create docs.flutter.dev infra.design Relates to the design of docs.flutter.dev p1-high Major but not urgent concern: Resolve in months. Update each month. e3-weeks Effort: < 4 weeks from.team Reported by Dash docs team member labels Feb 26, 2024
@parlough parlough self-assigned this Feb 26, 2024
@parlough parlough mentioned this issue Feb 26, 2024
Merged
sfshaza2 pushed a commit that referenced this issue Feb 27, 2024
@parlough
Remove or replace usages of symlinks to site-shared (#10204)
7e3d7a6 
Fixes #6443

Contributes to #10203
@parlough parlough mentioned this issue Feb 28, 2024
Merged
parlough added a commit that referenced this issue Feb 28, 2024
@parlough
Transition from shell scripts to a Dart-based CLI (#10215)
635e75a 
This isn't the final state but helps prepare for the migration to 11ty.
More documentation will come with that as well :) - In the mean time,
you can run `dart run flutter_site --help` from the root directory of
the repo to learn more.

Contributes to #10203

Fixes #9745
@parlough parlough mentioned this issue Feb 28, 2024
Merged
atsansone pushed a commit that referenced this issue Feb 28, 2024
@parlough
Remove most Docker usage (#10216)
825cd5b 
This PR results in most of the site infrastructure no longer being
functional when developing locally. This is a temporary step in the
transition away from Docker and Jekyll to make the final migration and
its change review easier. You'll need to temporarily rely on the testing
and staging on GitHub. Some testing can be ran locally with `dart run
flutter_site <command>` if you have the latest Flutter installation.

This PR also pulls out the code excerpt check, as it's independent of
the Dart channel and testing. This avoids unnecessary work and enables
quicker visibility into failure reasons on CI :)

Please let me know if you have any concerns with this landing or need
help with something after it lands. Thank you!

Contributes to #10203
Closes #9450
@parlough parlough mentioned this issue Feb 29, 2024
Merged
parlough added a commit that referenced this issue Mar 1, 2024
@parlough
Remove usages of site.url variable (#10226)
2e2f9d6 
We don't rely on this, nor have we ever. It has caused confusion and
inconsistencies, ending up being one of the most common issues when a
new contributor opens a PR.

The downstream Chinese-translated version of the docs site does however
rely on this variable being used. Dropping it will result in a temporary
regression for them that I think they shouldn't account for by staying
on an older commit until #10203
is solved. As another solution would end up being temporary and likely
not worth the effort.

Contributes to #10203
This was referenced Mar 7, 2024
Closed
Merged
atsansone pushed a commit that referenced this issue Mar 7, 2024
@parlough
Clean up table wrapper and markdown syntax (#10254)
ceb51fc 
Contributes to #10203 as the
setup will be more strict with raw HTML usage in Markdown.
This was referenced Mar 10, 2024
Merged
Merged
parlough added a commit that referenced this issue Mar 11, 2024
@parlough
Switch to pnpm and update firebase-tools (#10264)
6e4aa92 
Contributes to #10203
This was referenced Mar 11, 2024
Merged
Merged
sfshaza2 pushed a commit that referenced this issue Mar 11, 2024
@parlough
Remove use of include_cached plugin (#10268)
a7de95c 
Contributes to #10203 as we'll
only use normal Liquid includes and render syntax after the migration.

The usage of `include_cached` was simply a performance optimization, so
this doesn't affect rendering results.
sfshaza2 pushed a commit that referenced this issue Mar 11, 2024
@parlough
Only create TOC entries for h2 and h3 (#10267)
5fd4fd9 
Limits TOC entries to h2 and h3 as it's usually not desired for h4 to be
included anyway, as can be seen by the removal of `no_toc` in many h4
cases here. In the future, we can configure this per page as necessary.

Contributes to #10203
sfshaza2 pushed a commit that referenced this issue Mar 13, 2024
@parlough @domesticmouse
Update styles for fixes and closer alignment to dart.dev (#10265)
b66d96b 
This results in closer alignment to dart.dev and includes the
improvements of:

- Improved accessibility of text in asides/admonitions with greatly
increased contrast
- Less distracting right TOC styles
- The inline TOC has a background to visually differentiate it from
nearby content

Contributes to #10203

---------

Co-authored-by: Brett Morgan <brettmorgan@google.com>
@parlough parlough mentioned this issue Mar 16, 2024
Merged
atsansone pushed a commit to atsansone/website that referenced this issue Mar 18, 2024
@parlough @atsansone
Switch to pnpm and update firebase-tools (flutter#10264)
4a3615d 
Contributes to flutter#10203
atsansone pushed a commit to atsansone/website that referenced this issue Mar 18, 2024
@parlough @atsansone
Remove use of include_cached plugin (flutter#10268)
5bf9bff 
Contributes to flutter#10203 as we'll
only use normal Liquid includes and render syntax after the migration.

The usage of `include_cached` was simply a performance optimization, so
this doesn't affect rendering results.
atsansone pushed a commit to atsansone/website that referenced this issue Mar 18, 2024
@parlough @atsansone
Only create TOC entries for h2 and h3 (flutter#10267)
70b1d92 
Limits TOC entries to h2 and h3 as it's usually not desired for h4 to be
included anyway, as can be seen by the removal of `no_toc` in many h4
cases here. In the future, we can configure this per page as necessary.

Contributes to flutter#10203
atsansone pushed a commit to atsansone/website that referenced this issue Mar 18, 2024
@parlough @domesticmouse @atsansone
Update styles for fixes and closer alignment to dart.dev (flutter#10265)
7679cab 
This results in closer alignment to dart.dev and includes the
improvements of:

- Improved accessibility of text in asides/admonitions with greatly
increased contrast
- Less distracting right TOC styles
- The inline TOC has a background to visually differentiate it from
nearby content

Contributes to flutter#10203

---------

Co-authored-by: Brett Morgan <brettmorgan@google.com>
parlough added a commit that referenced this issue Mar 23, 2024
@parlough
Convert HTML definition lists to Markdown (#10300)
f513dad 
Makes syntax for definition lists consistent across the site making
contributing easier and more consistent.

Contributes to #10203
This was referenced Mar 25, 2024
Merged
Merged
parlough added a commit that referenced this issue Mar 25, 2024
@parlough
Codeblock language cleanup (#10334)
9b1224f 
- Adding missing code block languages
- Change `terminal` to `console`
- Standardize `text`, `nocode`, `plain`, etc., all to `plaintext`

Some of these will result in temporary style regressions, but will be
resolved shortly.

Contributes to #10203
parlough added a commit that referenced this issue Mar 25, 2024
@parlough
Add root dash_site command for consistency with dart.dev (#10333)
12487e4 
This command will be used as an easy entry point into site tooling while
also verifying the user's setup and conveying any issues.

Instructions for use will come in follow-up PRs.

Contributes to #10203
@parlough parlough mentioned this issue Mar 26, 2024
Merged
@sfshaza2
Copy link
Contributor

sfshaza2 commented Apr 3, 2024

Where are we on this, @parlough? Given that it's a P1 bug, I'd like to get this addressed and closed.

@parlough
Copy link
Member Author

parlough commented Apr 3, 2024

Working on fixing the final discrepancies in #10336 :)

parlough added a commit that referenced this issue Apr 4, 2024
@parlough
Migrate to 11ty (#10336)
b0e004c 
Closes #10203
Fixes #10335
Fixes #9524
atsansone pushed a commit to atsansone/website that referenced this issue Apr 5, 2024
@parlough @atsansone
Remove or replace usages of symlinks to site-shared (flutter#10204)
0d0714a 
Fixes flutter#6443

Contributes to flutter#10203
atsansone pushed a commit to atsansone/website that referenced this issue Apr 5, 2024
@parlough @atsansone
Transition from shell scripts to a Dart-based CLI (flutter#10215)
5634b17 
This isn't the final state but helps prepare for the migration to 11ty.
More documentation will come with that as well :) - In the mean time,
you can run `dart run flutter_site --help` from the root directory of
the repo to learn more.

Contributes to flutter#10203

Fixes flutter#9745
atsansone pushed a commit to atsansone/website that referenced this issue Apr 5, 2024
@parlough @atsansone
Remove most Docker usage (flutter#10216)
df86d1b 
This PR results in most of the site infrastructure no longer being
functional when developing locally. This is a temporary step in the
transition away from Docker and Jekyll to make the final migration and
its change review easier. You'll need to temporarily rely on the testing
and staging on GitHub. Some testing can be ran locally with `dart run
flutter_site <command>` if you have the latest Flutter installation.

This PR also pulls out the code excerpt check, as it's independent of
the Dart channel and testing. This avoids unnecessary work and enables
quicker visibility into failure reasons on CI :)

Please let me know if you have any concerns with this landing or need
help with something after it lands. Thank you!

Contributes to flutter#10203
Closes flutter#9450
atsansone pushed a commit to atsansone/website that referenced this issue Apr 5, 2024
@parlough @atsansone
Remove usages of site.url variable (flutter#10226)
4fc0c61 
We don't rely on this, nor have we ever. It has caused confusion and
inconsistencies, ending up being one of the most common issues when a
new contributor opens a PR.

The downstream Chinese-translated version of the docs site does however
rely on this variable being used. Dropping it will result in a temporary
regression for them that I think they shouldn't account for by staying
on an older commit until flutter#10203
is solved. As another solution would end up being temporary and likely
not worth the effort.

Contributes to flutter#10203
atsansone pushed a commit to atsansone/website that referenced this issue Apr 5, 2024
@parlough @atsansone
Clean up table wrapper and markdown syntax (flutter#10254)
3c51024 
Contributes to flutter#10203 as the
setup will be more strict with raw HTML usage in Markdown.
atsansone pushed a commit to atsansone/website that referenced this issue Apr 5, 2024
@parlough @atsansone
Switch to pnpm and update firebase-tools (flutter#10264)
7a9e854 
Contributes to flutter#10203
atsansone pushed a commit to atsansone/website that referenced this issue Apr 5, 2024
@parlough @atsansone
Remove use of include_cached plugin (flutter#10268)
1827124 
Contributes to flutter#10203 as we'll
only use normal Liquid includes and render syntax after the migration.

The usage of `include_cached` was simply a performance optimization, so
this doesn't affect rendering results.
atsansone pushed a commit to atsansone/website that referenced this issue Apr 5, 2024
@parlough @atsansone
Only create TOC entries for h2 and h3 (flutter#10267)
6b9798a 
Limits TOC entries to h2 and h3 as it's usually not desired for h4 to be
included anyway, as can be seen by the removal of `no_toc` in many h4
cases here. In the future, we can configure this per page as necessary.

Contributes to flutter#10203
atsansone pushed a commit to atsansone/website that referenced this issue Apr 5, 2024
@parlough @domesticmouse @atsansone
Update styles for fixes and closer alignment to dart.dev (flutter#10265)
e6f589a 
This results in closer alignment to dart.dev and includes the
improvements of:

- Improved accessibility of text in asides/admonitions with greatly
increased contrast
- Less distracting right TOC styles
- The inline TOC has a background to visually differentiate it from
nearby content

Contributes to flutter#10203

---------

Co-authored-by: Brett Morgan <brettmorgan@google.com>
atsansone pushed a commit to atsansone/website that referenced this issue Apr 5, 2024
@parlough @atsansone
Convert HTML definition lists to Markdown (flutter#10300)
3c83b56 
Makes syntax for definition lists consistent across the site making
contributing easier and more consistent.

Contributes to flutter#10203
atsansone pushed a commit to atsansone/website that referenced this issue Apr 5, 2024
@parlough @atsansone
Codeblock language cleanup (flutter#10334)
9f441a4 
- Adding missing code block languages
- Change `terminal` to `console`
- Standardize `text`, `nocode`, `plain`, etc., all to `plaintext`

Some of these will result in temporary style regressions, but will be
resolved shortly.

Contributes to flutter#10203
atsansone pushed a commit to atsansone/website that referenced this issue Apr 5, 2024
@parlough @atsansone
Add root dash_site command for consistency with dart.dev (flutter#10333)
f616784 
This command will be used as an easy entry point into site tooling while
also verifying the user's setup and conveying any issues.

Instructions for use will come in follow-up PRs.

Contributes to flutter#10203
atsansone pushed a commit to atsansone/website that referenced this issue Apr 5, 2024
@parlough @atsansone
Migrate to 11ty (flutter#10336)
4de500e 
Closes flutter#10203
Fixes flutter#10335
Fixes flutter#9524
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@parlough parlough

Labels
e3-weeks Effort: < 4 weeks from.team Reported by Dash docs team member infra.design Relates to the design of docs.flutter.dev infra.structure Relates to the tools that create docs.flutter.dev p1-high Major but not urgent concern: Resolve in months. Update each month.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Migrate to 11ty flutter/website
3 participants
@atsansone @parlough @sfshaza2