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.

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

build: rework ci/gha docs #15898

Merged
merged 1 commit into from
Nov 3, 2022
Merged

build: rework ci/gha docs #15898

merged 1 commit into from
Nov 3, 2022

Conversation

dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Oct 18, 2022

This PR brings a restructuring of GitHub actions documentation, and expands on the existing docs by:

  • Rewriting the CI description (currently based on an old blog post)
  • Updating the guide/tutorial for GitHub Actions
  • Including examples of advanced use cases

@netlify
Copy link

netlify bot commented Oct 18, 2022

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit f636cc2
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6363db697c446e00085e25f6
😎 Deploy Preview https://deploy-preview-15898--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.

@dvdksn dvdksn changed the title Restructure GitHub actions docs WIP: Restructure GitHub actions docs Oct 18, 2022
@dvdksn dvdksn force-pushed the github-actions branch 2 times, most recently from 5ccd41b to f62b12a Compare October 19, 2022 13:31
@dvdksn dvdksn force-pushed the github-actions branch 3 times, most recently from 6f44472 to f1b055d Compare November 2, 2022 08:46
@dvdksn
Copy link
Contributor Author

dvdksn commented Nov 2, 2022

@crazy-max do you know why the gha advanced example pages do not get any breadcrumbs??

image

@crazy-max
Copy link
Member

crazy-max commented Nov 2, 2022

@crazy-max do you know why the gha advanced example pages do not get any breadcrumbs??

image

Hum I don't know, maybe there is a limit to the number of items? Any idea @thaJeztah?

Edit: yes looks limited to 4 levels:

{%- if level1_title -%}<li><a {%- if level1_url %} href="{{ level1_url }}"{%- endif -%}>{{ level1_title }}</a></li>{%- endif -%}
{%- if level2_title -%}<li><a {%- if level2_url %} href="{{ level2_url }}"{%- endif -%}>{{ level2_title }}</a></li>{%- endif -%}
{%- if level3_title -%}<li><a {%- if level3_url %} href="{{ level3_url }}"{%- endif -%}>{{ level3_title }}</a></li>{%- endif -%}
{%- if level4_title -%}<li><a {%- if level4_url %} href="{{ level4_url }}"{%- endif -%}>{{ level4_title }}</a></li>{%- endif -%}

Should be dynamic imo.

@dvdksn dvdksn force-pushed the github-actions branch 5 times, most recently from 5284ebc to b408cbf Compare November 2, 2022 13:04
@dvdksn dvdksn marked this pull request as ready for review November 2, 2022 13:04
@dvdksn dvdksn requested a review from jedevc as a code owner November 2, 2022 13:04
@dvdksn dvdksn changed the title WIP: Restructure GitHub actions docs rework ci/gha docs Nov 2, 2022
@dvdksn dvdksn changed the title rework ci/gha docs build: rework ci/gha docs Nov 2, 2022
_data/toc.yaml Outdated Show resolved Hide resolved
_data/toc.yaml Outdated Show resolved Hide resolved
_includes/gha-tutorial.md Show resolved Hide resolved
build/ci/github-actions/examples/tags-labels.md Outdated Show resolved Hide resolved
build/ci/github-actions/index.md Outdated Show resolved Hide resolved
Copy link
Member

@crazy-max crazy-max left a comment

Choose a reason for hiding this comment

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

I have mixed feeling about the examples layout. On one hand there are too many pages and TOC order is not quite satisfying. I wonder if this could just be on a single examples.md or cookbook.md page? WDYT?

build/ci/github-actions/examples/cache.md Outdated Show resolved Hide resolved
build/ci/github-actions/examples/cache.md Outdated Show resolved Hide resolved
build/ci/github-actions/examples/cache.md Outdated Show resolved Hide resolved
build/ci/github-actions/examples/isolated-builders.md Outdated Show resolved Hide resolved
build/ci/github-actions/examples/named-contexts.md Outdated Show resolved Hide resolved
@dvdksn dvdksn force-pushed the github-actions branch 2 times, most recently from 87816ac to 4ec213f Compare November 3, 2022 10:03
@dvdksn
Copy link
Contributor Author

dvdksn commented Nov 3, 2022

I have mixed feeling about the examples layout. On one hand there are too many pages and TOC order is not quite satisfying. I wonder if this could just be on a single examples.md or cookbook.md page? WDYT?

I agree and I've updated the structure now! ptal and let me know if there's anything else you'd like me to change :)

Also wouldn't hurt if you just glanced over the "template repo" that I created for the tutorial. Before my changes, we asked ppl to fork an existing repo that used nginx and static HTML. I created a slimmer version that is also a template repo: https://github.com/dvdksn/clockbox

Copy link
Member

@crazy-max crazy-max left a comment

Choose a reason for hiding this comment

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

Also wouldn't hurt if you just glanced over the "template repo" that I created for the tutorial. Before my changes, we asked ppl to fork an existing repo that used nginx and static HTML. I created a slimmer version that is also a template repo: https://github.com/dvdksn/clockbox

Yes your example looks good to me!

I agree and I've updated the structure now! ptal and let me know if there's anything else you'd like me to change :)

Some examples are more important than others. I think we should change the order and group some of them:

  • Push to multi-registries
  • Manage tags and labels
  • Multi-platform images
  • Cache
  • Secrets
  • Export image to Docker
  • Test your image before pushing it
  • Local registry
  • Share built image between jobs
  • Named contexts
  • Builder configuration
    • Append additional nodes
    • Authentication for remote builders
    • BuildKit daemon configuration
    • Standalone mode
  • Isolated builders
  • Copy images between registries
  • Update Docker Hub repository description

For Registry mirror we should cross link to https://deploy-preview-15898--docsdocker.netlify.app/build/buildkit/configure/#registry-mirror

build/ci/github-actions/examples.md Outdated Show resolved Hide resolved
build/ci/github-actions/examples.md Outdated Show resolved Hide resolved
_includes/gha-tutorial.md Outdated Show resolved Hide resolved
_includes/gha-tutorial.md Outdated Show resolved Hide resolved
_includes/gha-tutorial.md Show resolved Hide resolved
_includes/gha-tutorial.md Outdated Show resolved Hide resolved
_includes/gha-tutorial.md Show resolved Hide resolved
_includes/gha-tutorial.md Outdated Show resolved Hide resolved
build/ci/github-actions/index.md Show resolved Hide resolved
build/ci/github-actions/index.md Show resolved Hide resolved
build/ci/index.md Outdated Show resolved Hide resolved
build/ci/index.md Outdated Show resolved Hide resolved
Signed-off-by: David Karlsson <david.karlsson@docker.com>
Copy link
Member

@crazy-max crazy-max left a comment

Choose a reason for hiding this comment

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

LGTM 🎉

@dvdksn dvdksn merged commit 1c3e4b9 into docker:main Nov 3, 2022
@dvdksn dvdksn deleted the github-actions branch May 3, 2023 13:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants