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

docs: Add examples to the info sidebar #7906

Merged

Conversation

maggieneterval
Copy link
Contributor

Fixes: #6488

Description

Add relevant examples from the examples directory to the sidebar of each page.

User facing changes

Before:

Screen Shot 2022-10-03 at 11 42 34 AM

After:

Screen Shot 2022-10-03 at 11 38 11 AM

@maggieneterval
Copy link
Contributor Author

@aaron-prindle Could you please review this when you get a chance? Let me know if there are any presubmit steps or conventions I missed. Thank you!

Copy link
Contributor

@aaron-prindle aaron-prindle left a comment

Choose a reason for hiding this comment

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

LGTM! Just ran the updated docs locally and this is working great!

@aaron-prindle
Copy link
Contributor

nit: Can you also copy these changes over to docs/ (as well as docs-v2/. This changes would also help people looking at the v1 docs

@codecov
Copy link

codecov bot commented Oct 3, 2022

Codecov Report

Merging #7906 (7445c3f) into main (290280e) will decrease coverage by 3.77%.
The diff coverage is 53.94%.

@@            Coverage Diff             @@
##             main    #7906      +/-   ##
==========================================
- Coverage   70.48%   66.70%   -3.78%     
==========================================
  Files         515      593      +78     
  Lines       23150    28698    +5548     
==========================================
+ Hits        16317    19144    +2827     
- Misses       5776     8140    +2364     
- Partials     1057     1414     +357     
Impacted Files Coverage Δ
cmd/skaffold/app/cmd/credits/export.go 0.00% <0.00%> (ø)
cmd/skaffold/app/cmd/deploy.go 40.90% <0.00%> (-12.94%) ⬇️
cmd/skaffold/app/cmd/test.go 44.44% <0.00%> (ø)
cmd/skaffold/skaffold.go 0.00% <0.00%> (ø)
cmd/skaffold/app/cmd/inspect_tests.go 62.50% <14.28%> (-1.14%) ⬇️
cmd/skaffold/app/cmd/render.go 35.48% <18.18%> (-5.90%) ⬇️
cmd/skaffold/app/cmd/lsp.go 28.12% <28.12%> (ø)
cmd/skaffold/app/cmd/run.go 64.28% <33.33%> (-9.63%) ⬇️
cmd/skaffold/app/cmd/fix.go 56.41% <37.50%> (-20.07%) ⬇️
cmd/skaffold/app/cmd/verify.go 41.17% <41.17%> (ø)
... and 363 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@maggieneterval
Copy link
Contributor Author

nit: Can you also copy these changes over to docs/ (as well as docs-v2/. This changes would also help people looking at the v1 docs

My understanding was that docs/layouts/partials/info-panel.html was the partial for v1, and docs-v2/layouts/partials/info-panel.html was the partial for v2. Both are updated; are there updates to any other files required for these changes to take effect in both v1 and v2?

@aaron-prindle
Copy link
Contributor

aaron-prindle commented Oct 3, 2022

Sorry, my mistake - I didn't realize both docs/ and docs-v2/ were updated! You are right, you made the correct changes initially.. LGTM, nothing else needs to be done

@aaron-prindle aaron-prindle enabled auto-merge (squash) October 3, 2022 18:45
@aaron-prindle aaron-prindle merged commit fe99b98 into GoogleContainerTools:main Oct 3, 2022
OladapoAjala pushed a commit to OladapoAjala/skaffold that referenced this pull request Oct 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs fixit] [technical writers review] [HaTS feedback] Pages should link to relevant github repo examples
2 participants