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

[SS2-783] Update product docs for findings #591

Merged
merged 10 commits into from
Dec 16, 2024

Conversation

molfinn
Copy link
Contributor

@molfinn molfinn commented Dec 9, 2024

Changelog

Added

Page Deploy Preview Comment
Name Link Comment

Updated

Page Deploy Preview Comment
Name Link Comment

Preview This Change

To see how this change looks in production, scroll down to Deploy Preview. Select the link that looks like https://deploy-preview-<num>--cobalt-docs.netlify.app/

Variables

Help us support a “Write once, publish everywhere” single source of truth. If you see a line that looks like:

{{% asset-categories %}}

You’ve found a shortcode that we include in multiple documents.

You’ll find the content of the shortcode in the following directory:

https://github.com/cobalthq/cobalt-product-public-docs/tree/main/layouts/shortcodes

That shortcode has the same base name as what you see in the PR, such as asset-categories.html.

Checklist for PR Author

[ ] Did you check for broken links and alt text?

Be sure to check for broken links and Alt Text issues. We have a partially automated process,
as described in this section of our repository README:
Test Links and Alt Attributes.

@molfinn molfinn requested a review from mtsuji-cobalt December 9, 2024 20:21
Copy link

netlify bot commented Dec 9, 2024

Deploy Preview for cobalt-docs ready!

Name Link
🔨 Latest commit 1e1575f
🔍 Latest deploy log https://app.netlify.com/sites/cobalt-docs/deploys/67575d98770c530008dd3bb6
😎 Deploy Preview https://deploy-preview-591--cobalt-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@molfinn molfinn requested a review from stef-cobaltio December 9, 2024 20:42
@molfinn
Copy link
Contributor Author

molfinn commented Dec 9, 2024

@stef-cobaltio @mtsuji-cobalt : can you review this for me please? It's the changes to the Findings page.

To view all findings reported within your organization, navigate to the **Findings** page. You need an [Organization Owner](/platform-deep-dive/collaboration/user-roles/#organization-owner) or [Member](/platform-deep-dive/collaboration/user-roles/#organization-member) role to view this page.

{{% alert title="Note" color="primary" %}}
Organization Members will be limited in their Findings view, depending on [group](/platform-deep-dive/collaboration/groups) membership.
Copy link
Contributor

Choose a reason for hiding this comment

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

For some reason, this sentence is broken into two lines

Screenshot 2024-12-09 at 15 53 39

Copy link
Contributor

Choose a reason for hiding this comment

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

I fixed this by updating the code from:
{{% alert title="Note" color="primary" %}}
{{% /alert %}}
to
{{< alert title="Note" color="primary" >}}
{{< /alert >}}

@mtsuji-cobalt mtsuji-cobalt self-requested a review December 9, 2024 21:17
@molfinn molfinn merged commit 85b7978 into main Dec 16, 2024
10 checks passed
@molfinn molfinn deleted the chore/SS2-783/update-docs-for-findings branch December 16, 2024 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants