Added description of Docs capability for "alerts" #9179
Conversation
Signed-off-by: Debaditya Som <121785700+Debaditya-Som@users.noreply.github.com>
|
Yay, your first pull request! 👍 A contributor will be by to give feedback soon. In the meantime, you can find updates in the #github-notifications channel in the community Slack. |
Debaditya-Som
changed the title
|
🚀 Preview for commit 0848e02 at: https://65379bfe063f8f156a1dbb37--meshery-docs-preview.netlify.app |
|
Let's discuss this on the Meshery dev call tomorrow at 7:30 pm IST / 9:00 am CT, |
Yes surely |
You're welcome :) |
|
@Debaditya-Som Let me know, what help you need :) |
|
@Debaditya-Som actually you need to add a new section describing "alerts.html" in this file - |
Okay got it, so I need to create a section in the mentioned file. Could you tell me whether the documentation that I have done in the archived version is accurate or not? |
@Debaditya-Som looks good to me, just move the given content to the specified file! |
Signed-off-by: Debaditya Som <121785700+Debaditya-Som@users.noreply.github.com>
Signed-off-by: Debaditya Som <121785700+Debaditya-Som@users.noreply.github.com>
@leecalcote ,@coder12git |
Also, do the changes suggested by me in the content and you need to revert your commits too so that only those changes will be shown in which you have done changes, in your case just this file |
Yes, I have also made the changes that was suggested by you, only the updated commit, that is the one made in the specified file is made and the previous changes were reverted. |
| @@ -954,434 +954,47 @@ <h3 id="assign">Assign</h3> | |||
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code> {% assign variable1 = true %} | |||
| </code></pre></div></div> | |||
|
|
|||
| <h3 id="Alerts">Alerts</h3> | |||
| The <code>alerts.html</code> file is used to format and display notes, warnings, and other informational callouts in Meshery. | |||
There was a problem hiding this comment.
Meshery Docs has a common include file alert.html , to provide consistent formatting for notes, warnings, and various informative callouts intended for the readers.
| The <code>alerts.html</code> file is used to format and display notes, warnings, and other informational callouts in Meshery. | ||
| It provides a consistent and visually appealing way to draw the user's attention to important information. | ||
| <p> | ||
| To use the <code>alerts.html</code> feature, include the following code snippet in your documentation: |
There was a problem hiding this comment.
File is alert.html not alerts.html
| @@ -356,4 +356,36 @@ The assign tag is used to create a new variable. It is written in the following | |||
| {% include code.html code=code_content %} | |||
|
|
|||
There was a problem hiding this comment.
| @Debaditya-Som Add the alert section just after this line. |
By revert, i mean revert your PR to only those commits which shows changes in the suggested file. |
Signed-off-by: Debaditya Som <121785700+Debaditya-Som@users.noreply.github.com>
Signed-off-by: Debaditya Som <121785700+Debaditya-Som@users.noreply.github.com>
I'm facing this error while reverting the initial commit |
|
I am facing merge conflict while working on this branch, I have created a new branch and submitted a new PR : #9226 , kindly review that PR and ignore this one |
Notes for Reviewers
Changes Made:
This PR fixes #9094
Signed commits