Skip to content

Commit

Permalink
Use inline HTML for heading tags, not Gitiles MD
Browse files Browse the repository at this point in the history
This syntax for creating ID tags for headings (typcially with complex
names) isn't supported in CommonMark, which is the standard used by our
MD linter. It's valid syntax in Gitiles MD, which is why the links work.

Upstream feature request to add support for this type of header ID:
DavidAnson/markdownlint#570

This is required for submariner-io#827.

Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
  • Loading branch information
dfarrell07 committed Oct 6, 2022
1 parent 4c0b1f7 commit 8e12c05
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/content/development/release-process/_index.en.md
Expand Up @@ -308,7 +308,7 @@ Once the `submariner-operator` and `submariner-charts` releases are complete, we
unpin the Shipyard Dapper base image version, that is set it back to `devel`. For ongoing development we want each project to
automatically pick up the latest changes to the base image.

### Step 5: Verify Release {id="verify"}
### Step 5: Verify Release <a id="verify"></a>

You can follow any of the [quick start guides](../../getting-started/quickstart).

Expand Down
2 changes: 1 addition & 1 deletion src/content/development/shipyard/targets/_index.en.md
Expand Up @@ -58,7 +58,7 @@ make deploy
* **`DEPLOYTOOL`**: The tool used to deploy Submariner itself (defaults to `operator`).
* **`LIGHTHOUSE`**: Deploys Lighthouse in addition to the basic Submariner deployment (defaults to `false`).

### E2E (End to End) {#e2e}
### E2E (End to End) <a id="e2e"></a>

Runs end to end testing on the deployed environment (if one isn't created yet, this target will first invoke the `deploy` target to do so).
The tests are taken from the project, unless it has no specific end to end tests, in which case generic testing using `subctl verify` is
Expand Down

0 comments on commit 8e12c05

Please sign in to comment.