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

github(summary): update learn more link #384

Merged
merged 1 commit into from
Jun 26, 2024
+1 −1
Merged

github(summary): update learn more link #384

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/github.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ export class GitHub {
.addRaw(`For a detailed look at the build, download the following build record archive and import it into Docker Desktop's Builds view. `)
.addBreak()
.addRaw(`Build records include details such as timing, dependencies, results, logs, traces, and other information about a build. `)
.addRaw(addLink('Learn more', 'https://docs.docker.com/go/build-summary/'))
.addRaw(addLink('Learn more', 'https://www.docker.com/blog/new-beta-feature-deep-dive-into-github-actions-docker-builds-with-docker-desktop/?utm_source=github&utm_medium=actions'))
Copy link
Member Author

Choose a reason for hiding this comment

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

also sets utm_source and utm_medium

Copy link

Choose a reason for hiding this comment

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

Go idea to add the UTM components. Do you think we should still use a go path and handle the redirect?
@dvdksn, maybe we should distill this post down into some "Introductory Guide" for users not familiar with Builds View?

Copy link

Choose a reason for hiding this comment

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

Hmm yeah, why not? We could have that intro page in the manual section for builds, and link off to the full description in the Docker Desktop section.

Copy link
Member Author

Choose a reason for hiding this comment

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

@colinhemmings

Do you think we should still use a go path and handle the redirect?

I don't think /go fits if we are using UTM parameters

Copy link

Choose a reason for hiding this comment

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

We have a few go-links with utm params, for example:
https://github.com/docker/docs/blob/main/data/redirects.yml#L694-L700

Copy link
Member Author

@crazy-max crazy-max Jun 25, 2024 •
edited

Choose a reason for hiding this comment

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

We have a few go-links with utm params, for example: https://github.com/docker/docs/blob/main/data/redirects.yml#L694-L700

How do we make sure the source/medium is right? For example if I open within my browser https://docs.docker.com/go/build-eap/ these are wrong as this does not come from Docker Desktop but directly from my browser. That's my concern.

Copy link

Choose a reason for hiding this comment

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

yeah, there is no guarantee that the link will be accessed only from the correct source, providing the correct utm.

.addRaw('</p>')
.addRaw(`<p>`)
.addRaw(`:arrow_down: ${addLink(`<strong>${Util.stringToUnicodeEntities(opts.uploadRes.filename)}</strong>`, artifactRelativeURL)} (${Util.formatFileSize(opts.uploadRes.size)})`)
Expand Down