Skip to content

jekyll: enable sitemap and local search for dev environment #15250

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
Merged
crazy-max merged 3 commits into from
Jul 29, 2022
Merged

jekyll: enable sitemap and local search for dev environment #15250

crazy-max merged 3 commits into from
Jul 29, 2022

Conversation

@crazy-max
Copy link
Member

@crazy-max crazy-max commented Jul 28, 2022 •
edited
Loading

closes #14784
also related to #15179 as well as follow-up #15153

To test changes for local search but also the sitemap in our lab environment we need to enable these features. Since Jekyll 4, sitemap generation as well as metadata.json is pretty well optimized and takes less than 1 second for our docs so I think we can enable them for all environments which will allow us to check if nothing is broken on netlify environments before merging PRs.

Stats for sitemap and local search disabled:

#14 34.53 Build Process Summary:
#14 34.53 
#14 34.53 | PHASE      |    TIME |
#14 34.53 +------------+---------+
#14 34.53 | RESET      |  0.0004 |
#14 34.53 | READ       | 19.5737 |
#14 34.53 | GENERATE   |  1.1804 |
#14 34.53 | RENDER     | 12.7393 |
#14 34.53 | CLEANUP    |  0.0185 |
#14 34.53 | WRITE      |  0.2298 |
#14 34.53 +------------+---------+
#14 34.53 | TOTAL TIME | 33.7421 |
#14 34.53
#14 34.53
#14 34.53 Site Render Stats:
#14 34.54
#14 34.54 | Filename                                           | Count |     Bytes |   Time |
#14 34.54 +----------------------------------------------------+-------+-----------+--------+
#14 34.54 | _layouts/docs.html                                 |   712 | 23595.86K |  6.711 |
#14 34.54 | _includes/header.html                              |   712 |  1780.88K |  4.597 |
#14 34.54 | _includes/breadcrumbs.html                         |   712 |   301.95K |  4.532 |
#14 34.54 | _includes/toc_pure_liquid.html                     |   699 |   566.29K |  1.466 |
#14 34.54 | _includes/cli.md                                   |   243 |  1488.15K |  0.266 |
#14 34.54 | _includes/read_time.html                           |   712 |    21.14K |  0.175 |
#14 34.54 | _includes/head.html                                |   713 |  3098.72K |  0.172 |
#14 34.54 | _includes/navigation.html                          |   712 |  1179.25K |  0.045 |
#14 34.54 | _layouts/redirect.html                             |  1059 |   484.21K |  0.043 |
#14 34.54 | sitemap.xml                                        |     1 |     1.12K |  0.029 |
#14 34.54 | glossary.md                                        |     1 |    30.24K |  0.026 |
#14 34.54 | get-started/orchestration.md                       |     1 |    19.13K |  0.010 |
#14 34.54 | engine/reference/commandline/run.md                |     1 |    51.60K |  0.010 |
#14 34.54 | engine/reference/commandline/service_update.md     |     1 |    28.39K |  0.010 |
#14 34.54 | engine/reference/commandline/container_run.md      |     1 |    24.12K |  0.009 |
#14 34.54 | engine/reference/commandline/service_create.md     |     1 |    58.24K |  0.009 |
#14 34.54 | engine/reference/commandline/create.md             |     1 |    21.48K |  0.009 |
#14 34.54 | engine/reference/commandline/container_create.md   |     1 |    23.56K |  0.008 |
#14 34.54 | _includes/footer.html                              |   713 |  4949.22K |  0.006 |
#14 34.54 | engine/reference/commandline/buildx_build.md       |     1 |    27.54K |  0.005 |
#14 34.54 | _includes/theme-switch.html                        |   713 |   264.59K |  0.004 |
#14 34.54 | engine/reference/commandline/build.md              |     1 |    35.58K |  0.004 |
#14 34.54 | engine/reference/commandline/image_build.md        |     1 |    10.08K |  0.004 |
#14 34.54 | engine/reference/commandline/builder_build.md      |     1 |     8.30K |  0.003 |
#14 34.54 | engine/reference/commandline/app.md                |     1 |    17.30K |  0.003 |
#14 34.54 | _includes/upgrade-cta.html                         |    11 |     6.76K |  0.003 |
#14 34.54 | engine/reference/commandline/compose_up.md         |     1 |    10.40K |  0.003 |
#14 34.54 | engine/reference/commandline/buildx_bake.md        |     1 |    26.05K |  0.002 |
#14 34.54 | engine/reference/commandline/container_update.md   |     1 |     8.61K |  0.002 |
#14 34.54 | engine/reference/commandline/compose_run.md        |     1 |    10.68K |  0.002 |
#14 34.54 | engine/reference/commandline/compose_build.md      |     1 |     8.06K |  0.002 |
#14 34.54 | engine/reference/commandline/swarm_init.md         |     1 |    12.24K |  0.002 |
#14 34.54 | engine/reference/commandline/network_create.md     |     1 |    13.36K |  0.002 |
#14 34.54 | engine/reference/commandline/buildx_create.md      |     1 |    11.87K |  0.002 |
#14 34.54 | engine/reference/commandline/compose.md            |     1 |    11.42K |  0.002 |
#14 34.54 | engine/reference/commandline/compose_convert.md    |     1 |     7.78K |  0.002 |
#14 34.54 | engine/reference/commandline/container_exec.md     |     1 |     7.35K |  0.002 |
#14 34.54 | engine/reference/commandline/container_ls.md       |     1 |     7.12K |  0.002 |
#14 34.54 | engine/reference/commandline/update.md             |     1 |     6.73K |  0.002 |
#14 34.54 | engine/reference/commandline/plugin_push.md        |     1 |     3.74K |  0.002 |
#14 34.54 | engine/reference/commandline/docker.md             |     1 |     9.74K |  0.002 |
#14 34.54 | js/toc.json                                        |     1 |    56.86K |  0.002 |
#14 34.54 | engine/reference/commandline/ps.md                 |     1 |    21.69K |  0.002 |
#14 34.54 | engine/reference/commandline/compose_exec.md       |     1 |     7.46K |  0.002 |
#14 34.54 | engine/reference/commandline/compose_ps.md         |     1 |    10.43K |  0.002 |
#14 34.54 | engine/reference/commandline/service_logs.md       |     1 |     6.92K |  0.002 |
#14 34.54 | engine/reference/commandline/container_logs.md     |     1 |     6.85K |  0.002 |
#14 34.54 | desktop/previous-versions/edge-releases-windows.md |     1 |   194.28K |  0.002 |
#14 34.54 | engine/reference/commandline/compose_logs.md       |     1 |     6.81K |  0.002 |
#14 34.54 | engine/reference/commandline/stack_ps.md           |     1 |    15.59K |  0.002 |
#14 34.54 +----------------------------------------------------+-------+-----------+--------+
#14 34.54 | TOTAL (for 50 files)                               |  7749 | 38575.77K | 18.202 |
#14 34.54
#14 34.54                     done in 33.755 seconds.
#14 34.54  Auto-regeneration: disabled. Use --watch to enable.
#14 34.56 + mkdir -p /out/js
#14 34.57 + echo '[]'
#14 DONE 36.3s

Enabled:

#12 32.94 Build Process Summary:
#12 32.94
#12 32.94 | PHASE      |    TIME |
#12 32.94 +------------+---------+
#12 32.94 | RESET      |  0.0002 |
#12 32.94 | READ       | 17.7280 |
#12 32.94 | GENERATE   |  1.2210 |
#12 32.94 | RENDER     | 13.0898 |
#12 32.94 | CLEANUP    |  0.0141 |
#12 32.94 | WRITE      |  0.2356 |
#12 32.94 +------------+---------+
#12 32.94 | TOTAL TIME | 32.2887 |
#12 32.94
#12 32.94
#12 32.94 Site Render Stats:
#12 32.95
#12 32.95 | Filename                                         | Count |     Bytes |   Time |
#12 32.95 +--------------------------------------------------+-------+-----------+--------+
#12 32.95 | _layouts/docs.html                               |   712 | 23625.76K |  6.742 |
#12 32.95 | _includes/header.html                            |   712 |  1780.88K |  4.585 |
#12 32.95 | _includes/breadcrumbs.html                       |   712 |   301.95K |  4.519 |
#12 32.95 | _includes/toc_pure_liquid.html                   |   699 |   566.29K |  1.487 |
#12 32.95 | _includes/cli.md                                 |   243 |  1488.15K |  0.271 |
#12 32.95 | _includes/read_time.html                         |   712 |    21.14K |  0.182 |
#12 32.95 | _includes/head.html                              |   713 |  3128.66K |  0.180 |
#12 32.95 | js/metadata.json                                 |     1 |   146.05K |  0.145 |
#12 32.95 | sitemap.xml                                      |     1 |    42.55K |  0.082 |
#12 32.95 | _includes/navigation.html                        |   712 |  1179.25K |  0.046 |
#12 32.95 | _layouts/redirect.html                           |  1059 |   484.21K |  0.040 |
#12 32.95 | glossary.md                                      |     1 |    30.24K |  0.025 |
#12 32.95 | engine/reference/commandline/service_update.md   |     1 |    28.39K |  0.010 |
#12 32.95 | get-started/orchestration.md                     |     1 |    19.13K |  0.010 |
#12 32.95 | engine/reference/commandline/container_create.md |     1 |    23.56K |  0.009 |
#12 32.95 | engine/reference/commandline/run.md              |     1 |    51.60K |  0.009 |
#12 32.95 | engine/reference/commandline/container_run.md    |     1 |    24.12K |  0.009 |
#12 32.95 | engine/reference/commandline/service_create.md   |     1 |    58.24K |  0.008 |
#12 32.95 | engine/reference/commandline/create.md           |     1 |    21.48K |  0.008 |
#12 32.95 | _includes/footer.html                            |   713 |  4949.22K |  0.007 |
#12 32.95 | engine/reference/commandline/buildx_build.md     |     1 |    27.54K |  0.005 |
#12 32.95 | engine/reference/commandline/build.md            |     1 |    35.58K |  0.005 |
#12 32.95 | _includes/theme-switch.html                      |   713 |   264.59K |  0.004 |
#12 32.95 | engine/reference/commandline/app.md              |     1 |    17.30K |  0.004 |
#12 32.95 | engine/reference/commandline/builder_build.md    |     1 |     8.30K |  0.004 |
#12 32.95 | engine/reference/commandline/image_build.md      |     1 |    10.08K |  0.003 |
#12 32.95 | _includes/upgrade-cta.html                       |    11 |     6.76K |  0.003 |
#12 32.95 | engine/reference/commandline/compose_up.md       |     1 |    10.40K |  0.003 |
#12 32.95 | engine/reference/commandline/compose_run.md      |     1 |    10.68K |  0.003 |
#12 32.95 | engine/reference/commandline/buildx_bake.md      |     1 |    26.05K |  0.002 |
#12 32.95 | engine/reference/commandline/swarm_init.md       |     1 |    12.24K |  0.002 |
#12 32.95 | engine/reference/commandline/compose_build.md    |     1 |     8.06K |  0.002 |
#12 32.95 | engine/reference/commandline/update.md           |     1 |     6.73K |  0.002 |
#12 32.95 | engine/reference/commandline/container_update.md |     1 |     8.61K |  0.002 |
#12 32.95 | engine/reference/commandline/compose.md          |     1 |    11.42K |  0.002 |
#12 32.95 | engine/reference/commandline/buildx_create.md    |     1 |    11.87K |  0.002 |
#12 32.95 | engine/reference/commandline/network_create.md   |     1 |    13.36K |  0.002 |
#12 32.95 | engine/reference/commandline/app_validate.md     |     1 |     4.28K |  0.002 |
#12 32.95 | engine/reference/commandline/compose_convert.md  |     1 |     7.78K |  0.002 |
#12 32.95 | engine/reference/commandline/container_exec.md   |     1 |     7.35K |  0.002 |
#12 32.95 | engine/reference/commandline/compose_exec.md     |     1 |     7.46K |  0.002 |
#12 32.95 | engine/reference/commandline/app_install.md      |     1 |     6.53K |  0.002 |
#12 32.95 | engine/reference/commandline/compose_ps.md       |     1 |    10.43K |  0.002 |
#12 32.95 | engine/reference/commandline/docker.md           |     1 |     9.74K |  0.002 |
#12 32.95 | engine/reference/commandline/container_ls.md     |     1 |     7.12K |  0.002 |
#12 32.95 | engine/reference/commandline/ps.md               |     1 |    21.69K |  0.002 |
#12 32.95 | engine/reference/commandline/compose_pull.md     |     1 |     8.40K |  0.002 |
#12 32.95 | engine/reference/commandline/stack_ps.md         |     1 |    15.59K |  0.002 |
#12 32.95 | desktop/previous-versions/edge-releases-mac.md   |     1 |   184.66K |  0.002 |
#12 32.95 | js/toc.json                                      |     1 |    56.86K |  0.002 |
#12 32.95 +--------------------------------------------------+-------+-----------+--------+
#12 32.95 | TOTAL (for 50 files)                             |  7749 | 38808.36K | 18.446 |
#12 32.95
#12 32.95                     done in 32.303 seconds.
#12 32.95  Auto-regeneration: disabled. Use --watch to enable.
#12 DONE 34.7s

Signed-off-by: CrazyMax crazy-max@users.noreply.github.com

crazy-max
crazy-max commented Jul 28, 2022
View reviewed changes
@netlify
Copy link

netlify bot commented Jul 28, 2022 •
edited
Loading

✅ Deploy Preview for docsdocker ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit d2fca0e
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/62e2e0bbbe89430009aad825
😎 Deploy Preview https://deploy-preview-15250--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@crazy-max
Copy link
Member Author

crazy-max commented Jul 28, 2022 •
edited
Loading

Not a regression but looks like last modification date is not populated with the jekyll-sitemap plugin. We should fix that in a follow-up.

https://deploy-preview-15250--docsdocker.netlify.app/sitemap.xml

image

@thaJeztah
Copy link
Member

thaJeztah commented Jul 28, 2022

Hmm... looks like something is broken in general on docs.docker.com; https://docs.docker.com/sitemap.xml looks like the env-var is not being substituted; did we break that somewhere along the line?

Funny thing is that the first entry actually looks to have a date set, but items following it don't?

Screenshot 2022-07-28 at 14 11 24

@crazy-max crazy-max mentioned this pull request Jul 28, 2022
Merged
crazy-max added 2 commits July 28, 2022 19:30
@crazy-max
jekyll: enable sitemap and local search for dev environment
614c4a7 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max
jekyll: add simple sitemap xsl
a288b44 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max crazy-max force-pushed the enable-metadata-and-sitemap branch from 41b9526 to 0859d0b Compare July 28, 2022 18:58
@crazy-max
Copy link
Member Author

crazy-max commented Jul 28, 2022

@thaJeztah Rebased and also moved the URLs fix script from the Dockerfile to a Jekyll plugin to be aligned with other plugins and allows netlify to use it as well.

@crazy-max
jekyll: move relative URLs fix from Dockerfile to Jekyll plugin
d2fca0e 
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
@crazy-max crazy-max force-pushed the enable-metadata-and-sitemap branch from 0859d0b to d2fca0e Compare July 28, 2022 19:17
thaJeztah
thaJeztah approved these changes Jul 29, 2022
View reviewed changes
Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sitemap can be viewed here; https://deploy-preview-15250--docsdocker.netlify.app/sitemap.xml

LGTM!

@thaJeztah
Copy link
Member

thaJeztah commented Jul 29, 2022

@usha-mandya PTAL

@crazy-max crazy-max merged commit 0110242 into docker:master Jul 29, 2022
@crazy-max crazy-max deleted the enable-metadata-and-sitemap branch July 29, 2022 14:24
This was referenced Jul 29, 2022
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thaJeztah thaJeztah thaJeztah approved these changes

@usha-mandya usha-mandya usha-mandya approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@crazy-max @thaJeztah @usha-mandya