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

Add Envoy support page and update theme #178

Merged
merged 2 commits into from
Dec 10, 2024
Merged

Conversation

daniellemaxwell
Copy link
Collaborator

@daniellemaxwell daniellemaxwell commented Dec 10, 2024

Scope of Changes:
This PR adds a page providing details about Envoy support. The Hugo theme was also updated which required a few build errors to be resolved.

Follow on stories were created to continue investigating some warnings that appear when building the site: SC-28640 & SC-28641

Acceptance Criteria:
https://tinyurl.com/2982xtyr

@@ -1 +1,2 @@
.hugo_build.lock
.hvm
Copy link
Collaborator Author

@daniellemaxwell daniellemaxwell Dec 10, 2024

Choose a reason for hiding this comment

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

I installed the hugo version manager to see if that would help me resolve issues with links inside the notice shortcode working.

@@ -14,7 +14,6 @@ enableMissingTranslationPlaceholders = false
[params]

# Source Code repository section
description = "TRISA Documentation"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This was removed to resolve a build error. An update to the theme required moving the description to _index.en.md. This was previously done, so deleting this line was the only requirement.

@@ -7,7 +7,7 @@ weight: 90
---

{{% notice style="tip" title="API Credentials" icon="rocket" %}}
In order to use the API you will have to generate an API Key Client ID and Secret either from the user interface, or by using the command line tool as described in ["creating api keys"]({{< relref "deploy.md#creating-api-keys" >}}).
In order to use the API you will have to generate an API Key Client ID and Secret either from the user interface, or by using the command line tool as described in ["creating api keys"]({{% relref "deploy.md#creating-api-keys" %}}).
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The change was made after noticing a warning message.

## How can we help?


| | Open Source | One-Time Setup | Managed Service |
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This table comes from the Envoy repo's README. If additional information should be included, let me know.

Copy link
Collaborator

@pdamodaran pdamodaran left a comment

Choose a reason for hiding this comment

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

Looks good @daniellemaxwell! Thanks for updating the TRISA documentation!

@daniellemaxwell daniellemaxwell merged commit 412a1ed into main Dec 10, 2024
4 checks passed
@daniellemaxwell daniellemaxwell deleted the sc-28417/support branch December 10, 2024 21:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants