Dev Site Update. [skip ci]

devGuide/bootcamp/contributeToDocs.html

@@ -36,7 +36,7 @@
 Now, you can make a pull request targeting the <code class="hljs inline no-lang">master</code> branch of the MarkBind repository.</p> <div id="pr-steps"><ol><li>Fill in the pull request template.</li> <li>Wait for the CI checks to pass.
 <ol><li>For first-time contributors, you may need to wait for the MarkBind team to approve your PR before the CI checks can run.</li></ol></li> <li>Verify that the PR preview is working.
 <ol><li>The PR preview is generated by netlify/markbind-master/deploy-preview.</li> <li>You can find the link to the PR preview in the checks section of the PR. <span class="image-wrapper"><img src="/devdocs/images/bootcamp/live_preview.png" alt="PR Checks Section" width="920" height="" loading="eager" class="img-fluid rounded"> <span class="image-caption"></span></span></li> <li>Open the link to the PR preview and ensure that your changes are reflected in the rendered site</li></ol></li> <li>Follow up with PR reviews and make changes as requested.</li></ol></div> <p>Since this is a hypothetical change, you do not need to raise a PR. You can refer to PR <a href="https://github.com/MarkBind/markbind/pull/1924">#1924</a> for an example.</p> <div class="alert box-container border-danger alert-border-left" data-v-6607c59e><!----> <div class="header-and-body" data-v-6607c59e><!----> <div class="box-body-wrapper" data-v-6607c59e><div class="icon-wrapper  text-danger" data-v-6607c59e><i class="fas fa-flag" data-v-6607c59e></i></div> <!----> <div class="contents" data-v-6607c59e><p data-v-6607c59e><strong data-v-6607c59e>Checkpoint</strong></p> <p data-v-6607c59e>For <span class="underline" data-v-6607c59e>actual</span> documentation changes, check that the following are true:</p> <ul class="contains-task-list" data-v-6607c59e><li class="task-list-item enabled" data-v-6607c59e><input type="checkbox" class="task-list-item-checkbox" data-v-6607c59e> The PR template has been filled in</li> <li class="task-list-item enabled" data-v-6607c59e><input type="checkbox" class="task-list-item-checkbox" data-v-6607c59e> The PR preview is working</li></ul></div> <!----></div></div></div> <h2 id="summary">Summary<a href="#summary" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>In this task, you have learned how to make documentation changes to MarkBind!</p> <p>While documentation changes are not as exciting as code changes, they are still important. In particular, our documentation is generated by MarkBind itself, utilizing the same features that we are documenting. This means that our documentation is a great place to discover and analyze how MarkBind is used!</p> <p>Here are some additional tasks for you to try out:</p> <ul class="contains-task-list"><li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> Review a real documentation change (e.g <a href="https://github.com/MarkBind/markbind/issues/1772">issue #1772</a> was resolved in <a href="https://github.com/MarkBind/markbind/pull/1924">PR #1924</a> to improve the user guide)</li> <li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> Check if there are <a href="https://github.com/MarkBind/markbind/issues?q=is%3Aopen+label%3A%22a-Documentation+%F0%9F%93%9D%22+sort%3Aupdated-desc">existing issues</a> tagged with the <code class="hljs inline no-lang">a-Documentation</code> label
-<ul class="contains-task-list"><li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> If there are, try to resolve them!</li> <li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> If there are not, raise an issue when you discover a documentation bug or improvement (e.g make this bootcamp documentation better)!</li></ul></li></ul> <p>When you are ready, move on to learn how to squash some bugs!</p> <div class="clearfix"><p><span class="float-start"><a href="/devdocs/devGuide/bootcamp/exploreMarkBind.html" class="btn btn-light"><span><span aria-hidden="true" class="far fa-arrow-alt-circle-left"></span> <span>Explore MarkBind as a User</span></span></a></span></p> <p><span class="float-end"><a href="/devdocs/devGuide/bootcamp/fixABug.html" class="btn btn-light"><span><span>Fix a Bug</span> <span aria-hidden="true" class="far fa-arrow-alt-circle-right"></span></span></a></span></p></div> <br></div> <nav id="page-nav" data-v-e6005420><div class="nav-component slim-scroll" data-v-e6005420><nav id="mb-page-nav" class="nav nav-pills flex-column my-0 small no-flex-wrap" data-v-e6005420><a class="nav-link py-1" href="#contribute-to-documentation" data-v-e6005420>Contribute to Documentation‎</a> <nav class="nav nav-pills flex-column my-0 nested no-flex-wrap" data-v-e6005420><a class="nav-link py-1" href="#tldr" data-v-e6005420>TLDR‎</a> <a class="nav-link py-1" href="#reviewing-markbind-documentation" data-v-e6005420>Reviewing MarkBind Documentation‎</a> <a class="nav-link py-1" href="#make-modifications-to-the-documentation" data-v-e6005420>Make Modifications to the Documentation‎</a> <a class="nav-link py-1" href="#make-a-pull-request-and-amp-verify-the-pr-preview" data-v-e6005420>Make a Pull Request &amp; Verify the PR Preview‎</a> <a class="nav-link py-1" href="#summary" data-v-e6005420>Summary‎</a></nav> <!----></nav></div> <!----></nav> <div aria-hidden="true" class="scroll-top-button fa-lg d-print-none" style="display:none;bottom:2%;right:2%;position:fixed;"><i class="fas fa-arrow-circle-up"></i></div></div> <div><footer><div class="text-center"><small>[Generated by <a href="https://markbind.org/">MarkBind 5.4.0</a> on Fri, 19 Apr 2024, 2:14:53 UTC]</small><br> <small>This site is powered by <a href="https://www.netlify.com/">Netlify</a>.</small></div></footer></div></div>
+<ul class="contains-task-list"><li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> If there are, try to resolve them!</li> <li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> If there are not, raise an issue when you discover a documentation bug or improvement (e.g make this bootcamp documentation better)!</li></ul></li></ul> <p>When you are ready, move on to learn how to squash some bugs!</p> <div class="clearfix"><p><span class="float-start"><a href="/devdocs/devGuide/bootcamp/exploreMarkBind.html" class="btn btn-light"><span><span aria-hidden="true" class="far fa-arrow-alt-circle-left"></span> <span>Explore MarkBind as a User</span></span></a></span></p> <p><span class="float-end"><a href="/devdocs/devGuide/bootcamp/fixABug.html" class="btn btn-light"><span><span>Fix a Bug</span> <span aria-hidden="true" class="far fa-arrow-alt-circle-right"></span></span></a></span></p></div> <br></div> <nav id="page-nav" data-v-e6005420><div class="nav-component slim-scroll" data-v-e6005420><nav id="mb-page-nav" class="nav nav-pills flex-column my-0 small no-flex-wrap" data-v-e6005420><a class="nav-link py-1" href="#contribute-to-documentation" data-v-e6005420>Contribute to Documentation‎</a> <nav class="nav nav-pills flex-column my-0 nested no-flex-wrap" data-v-e6005420><a class="nav-link py-1" href="#tldr" data-v-e6005420>TLDR‎</a> <a class="nav-link py-1" href="#reviewing-markbind-documentation" data-v-e6005420>Reviewing MarkBind Documentation‎</a> <a class="nav-link py-1" href="#make-modifications-to-the-documentation" data-v-e6005420>Make Modifications to the Documentation‎</a> <a class="nav-link py-1" href="#make-a-pull-request-and-amp-verify-the-pr-preview" data-v-e6005420>Make a Pull Request &amp; Verify the PR Preview‎</a> <a class="nav-link py-1" href="#summary" data-v-e6005420>Summary‎</a></nav> <!----></nav></div> <!----></nav> <div aria-hidden="true" class="scroll-top-button fa-lg d-print-none" style="display:none;bottom:2%;right:2%;position:fixed;"><i class="fas fa-arrow-circle-up"></i></div></div> <div><footer><div class="text-center"><small>[Generated by <a href="https://markbind.org/">MarkBind 5.4.0</a> on Sun, 21 Apr 2024, 15:01:47 UTC]</small><br> <small>This site is powered by <a href="https://www.netlify.com/">Netlify</a>.</small></div></footer></div></div>
 </body><script src="/devdocs/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()

devGuide/bootcamp/exploreMarkBind.html

@@ -98,7 +98,7 @@
 
     </div>
     </button></div></pre></li> <li>Update your GitHub repository setting for deploying to GitHub Pages.
-<ol><li>Navigate to the Settings &gt; Pages section on GitHub for that repository and set the source to <code class="hljs inline no-lang">Deploy from a branch</code> and the branch to <code class="hljs inline no-lang">gh-pages</code> and <code class="hljs inline no-lang">/(root)</code>.</li></ol></li></ol> <div class="alert box-container border-danger alert-border-left" data-v-6607c59e><!----> <div class="header-and-body" data-v-6607c59e><!----> <div class="box-body-wrapper" data-v-6607c59e><div class="icon-wrapper  text-danger" data-v-6607c59e><i class="fas fa-flag" data-v-6607c59e></i></div> <!----> <div class="contents" data-v-6607c59e><p data-v-6607c59e><strong data-v-6607c59e>Checkpoint</strong></p> <p data-v-6607c59e>Check that the following are true:</p> <ul class="contains-task-list" data-v-6607c59e><li class="task-list-item enabled" data-v-6607c59e><input type="checkbox" class="task-list-item-checkbox" data-v-6607c59e> The triggered GitHub action runs are successful</li> <li class="task-list-item enabled" data-v-6607c59e><input type="checkbox" class="task-list-item-checkbox" data-v-6607c59e> The site is deployed and available at <code class="hljs inline no-lang" data-v-6607c59e>https://&lt;username&gt;.github.io/mb-dev-xxx/</code> (after a few seconds to a few minutes)</li></ul> <p data-v-6607c59e>Congratulations! 🎉🎉🎉 You have deployed your MarkBind site!</p></div> <!----></div></div></div> <h2 id="summary">Summary<a href="#summary" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>In the first part of this bootcamp, we experimented with MarkBind as a user. We have set up the master branch of MarkBind and created a new MarkBind site. We have also created content with MarkBind components/syntax and deployed our site.</p> <p>Here are some additional tasks for you to try out:</p> <ul class="contains-task-list"><li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> Create a new MarkBind site with a different <a tags="environment--dg" href="https://markbind.org/userGuide/themes.html">theme</a></li> <li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> Try out MarkBind's <a tags="environment--dg" href="https://markbind.org/userGuide/reusingContents.html#includes">include mechanism</a></li> <li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> Create a dedicated MarkBind site for your personal usage and <a href="https://github.com/MarkBind/markbind/discussions/new?category=show-and-tell">share it with us</a> <ul><li>You can see some examples in the <a href="/devdocs/showcase.html">MarkBind showcase</a></li></ul></li></ul> <p>Take a break now ☕️ and we will continue with the second part of the bootcamp!</p> <div class="clearfix"><p><span class="float-start"><a href="/devdocs/devGuide/bootcamp/intro.html" class="btn btn-light"><span><span aria-hidden="true" class="far fa-arrow-alt-circle-left"></span> <span>Onboarding Bootcamp</span></span></a></span></p> <p><span class="float-end"><a href="/devdocs/devGuide/bootcamp/contributeToDocs.html" class="btn btn-light"><span><span>Contribute to Documentation</span> <span aria-hidden="true" class="far fa-arrow-alt-circle-right"></span></span></a></span></p></div> <br></div> <nav id="page-nav" data-v-e6005420><div class="nav-component slim-scroll" data-v-e6005420><nav id="mb-page-nav" class="nav nav-pills flex-column my-0 small no-flex-wrap" data-v-e6005420><a class="nav-link py-1" href="#explore-markbind-as-a-user" data-v-e6005420>Explore MarkBind as a User‎</a> <nav class="nav nav-pills flex-column my-0 nested no-flex-wrap" data-v-e6005420><a class="nav-link py-1" href="#tldr" data-v-e6005420>TLDR‎</a> <a class="nav-link py-1" href="#setup-the-master-branch-of-markbind" data-v-e6005420>Setup the master branch of MarkBind‎</a> <a class="nav-link py-1" href="#create-a-markbind-site" data-v-e6005420>Create a MarkBind site‎</a> <a class="nav-link py-1" href="#create-content-with-markbind" data-v-e6005420>Create Content with MarkBind‎</a> <a class="nav-link py-1" href="#modify-site-structure-and-configuration" data-v-e6005420>Modify Site Structure and Configuration‎</a> <a class="nav-link py-1" href="#deploy-your-markbind-site" data-v-e6005420>Deploy your MarkBind site‎</a> <a class="nav-link py-1" href="#summary" data-v-e6005420>Summary‎</a></nav> <!----></nav></div> <!----></nav> <div aria-hidden="true" class="scroll-top-button fa-lg d-print-none" style="display:none;bottom:2%;right:2%;position:fixed;"><i class="fas fa-arrow-circle-up"></i></div></div> <div><footer><div class="text-center"><small>[Generated by <a href="https://markbind.org/">MarkBind 5.4.0</a> on Fri, 19 Apr 2024, 2:14:53 UTC]</small><br> <small>This site is powered by <a href="https://www.netlify.com/">Netlify</a>.</small></div></footer></div></div>
+<ol><li>Navigate to the Settings &gt; Pages section on GitHub for that repository and set the source to <code class="hljs inline no-lang">Deploy from a branch</code> and the branch to <code class="hljs inline no-lang">gh-pages</code> and <code class="hljs inline no-lang">/(root)</code>.</li></ol></li></ol> <div class="alert box-container border-danger alert-border-left" data-v-6607c59e><!----> <div class="header-and-body" data-v-6607c59e><!----> <div class="box-body-wrapper" data-v-6607c59e><div class="icon-wrapper  text-danger" data-v-6607c59e><i class="fas fa-flag" data-v-6607c59e></i></div> <!----> <div class="contents" data-v-6607c59e><p data-v-6607c59e><strong data-v-6607c59e>Checkpoint</strong></p> <p data-v-6607c59e>Check that the following are true:</p> <ul class="contains-task-list" data-v-6607c59e><li class="task-list-item enabled" data-v-6607c59e><input type="checkbox" class="task-list-item-checkbox" data-v-6607c59e> The triggered GitHub action runs are successful</li> <li class="task-list-item enabled" data-v-6607c59e><input type="checkbox" class="task-list-item-checkbox" data-v-6607c59e> The site is deployed and available at <code class="hljs inline no-lang" data-v-6607c59e>https://&lt;username&gt;.github.io/mb-dev-xxx/</code> (after a few seconds to a few minutes)</li></ul> <p data-v-6607c59e>Congratulations! 🎉🎉🎉 You have deployed your MarkBind site!</p></div> <!----></div></div></div> <h2 id="summary">Summary<a href="#summary" onclick="event.stopPropagation()" class="fa fa-anchor"></a></h2> <p>In the first part of this bootcamp, we experimented with MarkBind as a user. We have set up the master branch of MarkBind and created a new MarkBind site. We have also created content with MarkBind components/syntax and deployed our site.</p> <p>Here are some additional tasks for you to try out:</p> <ul class="contains-task-list"><li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> Create a new MarkBind site with a different <a tags="environment--dg" href="https://markbind.org/userGuide/themes.html">theme</a></li> <li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> Try out MarkBind's <a tags="environment--dg" href="https://markbind.org/userGuide/reusingContents.html#includes">include mechanism</a></li> <li class="task-list-item enabled"><input type="checkbox" class="task-list-item-checkbox"> Create a dedicated MarkBind site for your personal usage and <a href="https://github.com/MarkBind/markbind/discussions/new?category=show-and-tell">share it with us</a> <ul><li>You can see some examples in the <a href="/devdocs/showcase.html">MarkBind showcase</a></li></ul></li></ul> <p>Take a break now ☕️ and we will continue with the second part of the bootcamp!</p> <div class="clearfix"><p><span class="float-start"><a href="/devdocs/devGuide/bootcamp/intro.html" class="btn btn-light"><span><span aria-hidden="true" class="far fa-arrow-alt-circle-left"></span> <span>Onboarding Bootcamp</span></span></a></span></p> <p><span class="float-end"><a href="/devdocs/devGuide/bootcamp/contributeToDocs.html" class="btn btn-light"><span><span>Contribute to Documentation</span> <span aria-hidden="true" class="far fa-arrow-alt-circle-right"></span></span></a></span></p></div> <br></div> <nav id="page-nav" data-v-e6005420><div class="nav-component slim-scroll" data-v-e6005420><nav id="mb-page-nav" class="nav nav-pills flex-column my-0 small no-flex-wrap" data-v-e6005420><a class="nav-link py-1" href="#explore-markbind-as-a-user" data-v-e6005420>Explore MarkBind as a User‎</a> <nav class="nav nav-pills flex-column my-0 nested no-flex-wrap" data-v-e6005420><a class="nav-link py-1" href="#tldr" data-v-e6005420>TLDR‎</a> <a class="nav-link py-1" href="#setup-the-master-branch-of-markbind" data-v-e6005420>Setup the master branch of MarkBind‎</a> <a class="nav-link py-1" href="#create-a-markbind-site" data-v-e6005420>Create a MarkBind site‎</a> <a class="nav-link py-1" href="#create-content-with-markbind" data-v-e6005420>Create Content with MarkBind‎</a> <a class="nav-link py-1" href="#modify-site-structure-and-configuration" data-v-e6005420>Modify Site Structure and Configuration‎</a> <a class="nav-link py-1" href="#deploy-your-markbind-site" data-v-e6005420>Deploy your MarkBind site‎</a> <a class="nav-link py-1" href="#summary" data-v-e6005420>Summary‎</a></nav> <!----></nav></div> <!----></nav> <div aria-hidden="true" class="scroll-top-button fa-lg d-print-none" style="display:none;bottom:2%;right:2%;position:fixed;"><i class="fas fa-arrow-circle-up"></i></div></div> <div><footer><div class="text-center"><small>[Generated by <a href="https://markbind.org/">MarkBind 5.4.0</a> on Sun, 21 Apr 2024, 15:01:47 UTC]</small><br> <small>This site is powered by <a href="https://www.netlify.com/">Netlify</a>.</small></div></footer></div></div>
 </body><script src="/devdocs/markbind/js/bootstrap-utility.min.js"></script>
 <script>
   MarkBind.setupWithSearch()