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

new alert for permissions #125

Merged
merged 11 commits into from
Jan 8, 2024
Merged

Conversation

iArchitSharma
Copy link
Contributor

@iArchitSharma iArchitSharma commented Dec 31, 2023

Notes for Reviewers
New alert type added
USE
Use the following Syntax to add a Alert:
{{< alert type="success" title="Note" >}} Your Note {{< /alert >}}

  • type="danger": Alert used to indicate something related to security.
  • type="info": Alert used to write some information.
  • type="warning": Alert used to indicate a warning that might need attention.
  • type="neutral": Alert used to indicate a neutral information.
  • type="success": Alert used to indicate a positive information.

By default, if you don't specify a title title="Your Title", the title will be the same as the type name.
image

This PR fixes #123

Signed commits

  • Yes, I signed my commits.

Signed-off-by: Archit Sharma <[email protected]>
Copy link

netlify bot commented Dec 31, 2023

Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit 22ff0f1
🔍 Latest deploy log https://app.netlify.com/sites/bejewelled-pegasus-b0ce81/deploys/659c48b8c4661f0007696efc
😎 Deploy Preview https://deploy-preview-125--bejewelled-pegasus-b0ce81.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.

Signed-off-by: Archit Sharma <[email protected]>
@leecalcote
Copy link
Member

@iArchitSharma will you add this new style and its intended use to a Layer5 Docs Contributing guide?

@iArchitSharma
Copy link
Contributor Author

sure @leecalcote

@leecalcote
Copy link
Member

Darn you, DNS

Signed-off-by: Archit Sharma <[email protected]>
Signed-off-by: Archit Sharma <[email protected]>
@iArchitSharma
Copy link
Contributor Author

Done @leecalcote

@@ -54,6 +54,14 @@ To display images in a pop-up modal, use the following syntax: `![alt text](/pat

**Note-> For images to show correctly on subpages, always provide the complete image path**

### Adding Alert to the site
Use the following Syntax to add a Alert:
Copy link
Member

@leecalcote leecalcote Dec 31, 2023

Choose a reason for hiding this comment

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

@iArchitSharma, this is good, but you need to think as a maintainer, asking what's good for the docs overall, not just getting done what specifically needs to be done for your single pull request.

Make sure that this is a general description of the manner in which our docs support info / notes / tips / alerts and so on, not just a permission alert.

Copy link
Member

Choose a reason for hiding this comment

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

Make a complete list of supported styles with example use, please.

Copy link
Member

Choose a reason for hiding this comment

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

This same thing already be done and measure the docs. If you don't find it, please create one. But, there should be one already.

@iArchitSharma iArchitSharma added the pr/draft WIP/Draft pull request label Jan 2, 2024
Signed-off-by: Archit Sharma <[email protected]>
Signed-off-by: Archit Sharma <[email protected]>
@iArchitSharma iArchitSharma removed the pr/draft WIP/Draft pull request label Jan 6, 2024
@iArchitSharma iArchitSharma merged commit 49d4faf into layer5io:master Jan 8, 2024
5 checks passed
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.

[Alert] New Alert Type for Permissions
2 participants