Commit Graph

48 Commits

Author SHA1 Message Date
Stefan Scherer 2671a073bf
Update code block examples (#22494)
<!--Delete sections as needed -->

## Description

This updates the code block examples to remove a reference to an old
domain name that is no longer used.

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-04-25 14:48:03 +01:00
Sarah Sanders e6d34217e8
Merge pull request #22008 from sarahsanders-docker/fix-contribute
chore: quick fix for contribute guide
2025-02-12 08:59:15 -05:00
Sarah Sanders 70ed1cee94 Wrap in markdown 2025-02-11 13:11:51 -05:00
Sarah Sanders f2c827f677
cx: remove EA from Docker Home/Admin Console/Settings (#21999)
## Description
- We are removing EA iconography in Docker Home/Settings/Admin Console
UI
- This PR removes it from the docs as well

## Related issues or tickets
- [ENGDOCS-2417](https://docker.atlassian.net/browse/ENGDOCS-2417)
- AC-4547
- https://github.com/docker/frontends/pull/11457

## Reviews
- [ ] Editorial review
- [ ] Product review

[ENGDOCS-2417]:
https://docker.atlassian.net/browse/ENGDOCS-2417?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
2025-02-11 11:11:56 -05:00
Sarah Sanders c2e5ebfb1e Quick fix for contribute guide Hugo error 2025-02-11 10:31:25 -05:00
Sarah Sanders 9f56d945a7
chore: summary bar cleanup (#21887)
## Description
- Updated "Contribute" guide to reference summary bars, added
instructions for using them
- Removed `introduced` partial, this is now replaced by the summary bar
`requires` value
- Updated all files using `introduced` partial to use summary bar,
updated YAML file w/ feature name and info

## Related issues or tickets
[ENGDOCS-2392](https://docker.atlassian.net/browse/ENGDOCS-2392)

## Reviews
- [ ] Technical review
- [ ] Editorial review

[ENGDOCS-2392]:
https://docker.atlassian.net/browse/ENGDOCS-2392?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
2025-01-30 07:54:26 -08:00
David Karlsson b9b18957e1 chore: update contribute link to website section
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-01-14 15:07:49 +01:00
David Karlsson 3cc0f0103f contrib: update guidelines and archetype for guides
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-30 16:07:26 +01:00
Arie Heinrich c17faccf17
Spelling fixes (#21230)
Christmas is early :) and i had some free time to go over all the
documents and fix all spelling mistakes i have found.
2024-10-24 13:02:40 +02:00
Allie Sadler b1256d572f
ENGDOCS-2265 (#21203)
* ENGDOCS-2265

* Apply suggestions from code review
2024-10-22 11:25:13 +01:00
David Karlsson 397cd3dc48 contrib: add guidelines for contributing Docker guides
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-10-16 12:28:17 +02:00
David Karlsson d3b966e9f6 deps: update material-symbols icons to v0.23.0
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-27 12:09:29 +02:00
Allie Sadler 9cc3c53c56
ENGDOCS-2233 (#21005)
* ENGDOCS-2233

* more weights
2024-09-26 14:17:07 +01:00
David Karlsson 2260278786 hugo: define sidebar badge using front matter
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-13 09:45:42 +02:00
David Karlsson e79d7a84bd hugo: add support for pageless links in sidebar
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-11 14:15:15 +02:00
David Karlsson bb3d7ee1e4 chore: remove unused front matter params
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-20 16:49:24 +02:00
Allie Sadler 54ab3df392
badge use (#20649) 2024-08-19 15:22:32 +01:00
David Karlsson be79aba1b6 contrib: update instructions and examples for callouts
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-16 10:29:51 +02:00
David Karlsson e3aa78b72c chore: update alert syntax
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-16 10:29:49 +02:00
Allie Sadler 87acb6a36e
ENGDOCS-2176 (#20569) 2024-08-09 11:41:32 +01:00
Allie Sadler 7537a1c47c
style guide addition (#20095) 2024-05-24 09:15:53 +01:00
David Karlsson ccb50a8467 hugo: add tags
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-04-23 10:47:54 +02:00
Stephanie Aurelio 32c9d9ddb7
Update guidelines for videos (#19813)
* add video guidelines

* update description

* fix typo and add guideline
2024-04-17 11:23:05 -07:00
David Karlsson b75fe78d4f lint: enable markdownlint MD022 / blanks-around-headings
Headings should be surrounded by blank lines

Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse headings that don't have a blank line before, and will parse them as regular text.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-04-17 09:36:28 +02:00
Allie Sadler b06163712b
Minor contribute updates (#19752)
* Minor contribute updates

* Minor contribute updates
2024-04-09 08:28:49 +01:00
David Karlsson b0b5d9e603 chore: add asciinema guidelines
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-03-27 18:02:18 +01:00
Allie Sadler 0b722c9aee
code highlighting (#19345)
* code highlighting

* Update content/contribute/components/code-blocks.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

---------

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-02-08 10:57:03 +00:00
David Karlsson 6225724f32 test: add lint rule for trailing punctuation in headings
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-02-01 15:57:19 +01:00
David Karlsson e1ac3a4f36 test: add lint rules for tables
Formatting for tables wasn't guarded by markdownlint validation rules,
which increases the risk of releasing incorrectly formatted tables.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-02-01 15:45:53 +01:00
David Karlsson 0ff3eb3aab hugo: migrate font icons to svg
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-25 12:28:38 +01:00
David Karlsson 28e564187c site: remove "reading time" indicator
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-01-15 17:29:17 +01:00
David Karlsson 151a76855a
Merge pull request #18805 from dvdksn/contrib-updates
chore: update contribution guidelines
2023-12-01 16:59:20 +01:00
David Karlsson 49f14f795c chore: update contribution guidelines
Moves most of the contribution guidelines to the well-known
CONTRIBUTING.md file

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-12-01 14:14:56 +01:00
Paulo Ribeiro 3380ca922c
fix: Fix minor syntax issue 2023-11-30 11:18:04 +00:00
David Karlsson 1fdb2e77d4 fix: broken glob path for lint job
Linting was only running on a subset of our Markdown files in `content`.
This change fixes the glob path, and adds appropriate exclude paths.
Because the glob pattern was incorrect before, we had lots of files that
didn't comply with the linting rules. This commit also fixes those
issues.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-11-04 10:50:02 +01:00
Craig Osterhout 9443cc8397
fix node.js guide and contribute guide redirect (#18475)
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
2023-10-20 09:22:12 -07:00
David Karlsson f8f858bfcf
Merge pull request #18425 from dvdksn/code-var-syntax
feat: code var syntax
2023-10-16 20:28:58 +02:00
David Karlsson e02dcae84b chore: quick refresh of the contribution guidelines
Just a quick pass to fix some obvious issues

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-10-15 13:03:15 +02:00
David Karlsson f96ccbcb1f chore: document standard code var syntax
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-10-13 20:36:41 +02:00
Allie Sadler 2d050d2fc9
fix watch (#18286)
Co-authored-by: Allie Sadler <alliesadler@f693mt7fh6.home>
2023-09-26 14:46:06 +01:00
Oleh Dmytrychenko ff37cf49de
Docu fixes (#18056)
* added missing context

* removed duplicate header
2023-09-18 10:51:44 +01:00
David Karlsson 4e9580edde fix(markup): broken link references
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-09-16 21:54:03 +02:00
Allie Sadler 639939ac5a
icon consistency (#18030)
* icon consistency

* icon inventory

---------

Co-authored-by: Allie Sadler <alliesadler@f693mt7fh6.home>
2023-08-30 08:46:06 +01:00
David Karlsson c379bec61b contribute: update to use compose watch
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-08-23 15:42:54 +02:00
Stephanie Aurelio 3c6bb85c52
fix shortcodes and update callouts (#17976)
* fix shortcodes and update callouts

* update shortcode
2023-08-22 10:31:09 -07:00
Allie Sadler e66e7800b1
Post migration tidy (#17968)
* desktop fixes

* extensions tidy

* extras

* fix

* fix

---------

Co-authored-by: Allie Sadler <alliesadler@f693mt7fh6.home>
2023-08-22 15:08:47 +01:00
David Karlsson 15e9e1e694 hugo: run migration script
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-08-22 09:42:25 +02:00
David Karlsson a0d21ade2f migrate to hugo
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2023-08-22 09:41:02 +02:00