Skip to content

Commit

Permalink
Dev Site Update. [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Aug 11, 2024
1 parent d276786 commit 06beafc
Show file tree
Hide file tree
Showing 52 changed files with 99 additions and 99 deletions.
4 changes: 2 additions & 2 deletions about.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion about.page-vue-render.js

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions devGuide/bootcamp/contributeToDocs.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
const baseUrl = '/devdocs'
</script>
<body data-bs-spy="scroll" data-bs-target="#mb-page-nav" data-bs-offset="100" >
<div id="app" data-server-rendered="true"><header sticky=""><div data-v-7c0fd418><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-7c0fd418><div class="container-fluid" data-v-7c0fd418><div class="navbar-left" data-v-7c0fd418><a href="/devdocs/index.html" title="Home" class="navbar-brand" data-v-7c0fd418><img src="/devdocs/images/logo-darkbackground.svg" height="20" data-v-7c0fd418></a></div> <div class="navbar-default" data-v-7c0fd418><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-7c0fd418> <li data-v-7c0fd418><a highlight-on="exact" href="/devdocs/index.html" class="nav-link" data-v-7c0fd418>HOME</a></li> <div tags="environment--dg environment--combined" data-v-7c0fd418><li data-v-7c0fd418><a highlight-on="sibling-or-child" href="/devdocs/devGuide/index.html" class="nav-link" data-v-7c0fd418>DEVELOPER GUIDE</a></li></div> <li data-v-7c0fd418><a highlight-on="exact" href="/devdocs/showcase.html" class="nav-link" data-v-7c0fd418>SHOWCASE</a></li> <li data-v-7c0fd418><a highlight-on="exact" href="/devdocs/about.html" class="nav-link" data-v-7c0fd418>ABOUT</a></li> <li data-v-7c0fd418><a href="https://github.com/MarkBind/markbind" target="_blank" class="nav-link" data-v-7c0fd418><span data-v-7c0fd418><span aria-hidden="true" class="fab fa-github" data-v-7c0fd418></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-7c0fd418><li data-v-7c0fd418><form class="navbar-form" data-v-7c0fd418><div class="dropdown" style="position:relative;" data-v-cea1a814><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-cea1a814> <div class="form-control placeholder-div-hidden" data-v-cea1a814>
<div id="app" data-server-rendered="true"><header sticky=""><div data-v-7c0fd418><nav class="navbar navbar-expand-md d-print-none navbar-dark bg-dark" data-v-7c0fd418><div class="container-fluid" data-v-7c0fd418><div class="navbar-left" data-v-7c0fd418><a href="/devdocs/index.html" title="Home" class="navbar-brand" data-v-7c0fd418><img src="/devdocs/images/logo-darkbackground.svg" height="20" data-v-7c0fd418></a></div> <div class="navbar-default" data-v-7c0fd418><ul class="navbar-nav me-auto mt-2 mt-lg-0" data-v-7c0fd418> <li data-v-7c0fd418><a highlight-on="exact" href="/devdocs/index.html" class="nav-link" data-v-7c0fd418>HOME</a></li> <div tags="environment--dg environment--combined" data-v-7c0fd418><li data-v-7c0fd418><a highlight-on="sibling-or-child" href="/devdocs/devGuide/index.html" class="nav-link" data-v-7c0fd418>DEVELOPER GUIDE</a></li></div> <li data-v-7c0fd418><a highlight-on="exact" href="/devdocs/showcase.html" class="nav-link" data-v-7c0fd418>SHOWCASE</a></li> <li data-v-7c0fd418><a highlight-on="exact" href="/devdocs/about.html" class="nav-link" data-v-7c0fd418>ABOUT</a></li> <li data-v-7c0fd418><a href="https://github.com/MarkBind/markbind" target="_blank" class="nav-link" data-v-7c0fd418><span data-v-7c0fd418><span aria-hidden="true" class="fab fa-github" data-v-7c0fd418></span></span></a></li></ul></div> <ul class="navbar-nav navbar-right" data-v-7c0fd418><li data-v-7c0fd418><form class="navbar-form" data-v-7c0fd418><div class="dropdown" style="position:relative;" data-v-4f6e9aec><input data-bs-toggle="dropdown" type="text" placeholder="Search" autocomplete="off" value="" class="form-control" data-v-4f6e9aec> <div class="form-control placeholder-div-hidden" data-v-4f6e9aec>
Search
</div> <ul class="dropdown-menu search-dropdown-menu d-none dropdown-menu-end" data-v-cea1a814></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-7c0fd418><!----> <!----></div></div></header> <div id="flex-body"><nav id="site-nav" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="fw-bold mb-2" style="font-size:1.25rem;" data-v-e6005420>Developer Guide</div></div> <div class="nav-component slim-scroll" data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/devdocs/devGuide/devGuide.html" data-v-e6005420>Contributing</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420>Onboarding Bootcamp
</div> <ul class="dropdown-menu search-dropdown-menu dropdown-menu-hidden dropdown-menu-end" data-v-4f6e9aec></ul></div></form></li></ul></div></nav> <div class="lower-navbar-container" style="display:none;" data-v-7c0fd418><!----> <!----></div></div></header> <div id="flex-body"><nav id="site-nav" data-v-e6005420><div class="site-nav-top" data-v-e6005420><div class="fw-bold mb-2" style="font-size:1.25rem;" data-v-e6005420>Developer Guide</div></div> <div class="nav-component slim-scroll" data-v-e6005420><div class="site-nav-root"><ul class="site-nav-list site-nav-list-root" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420><a href="/devdocs/devGuide/devGuide.html" data-v-e6005420>Contributing</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420>Onboarding Bootcamp

<div class="site-nav-dropdown-btn-container" data-v-e6005420><i onclick="handleSiteNavClick(this.parentNode.parentNode, false); event.stopPropagation();" class="site-nav-dropdown-btn-icon" data-v-e6005420><span aria-hidden="true" class="glyphicon glyphicon-menu-down" data-v-e6005420></span></i></div></div><ul class="site-nav-dropdown-container site-nav-list" data-v-e6005420><li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/devdocs/devGuide/bootcamp/intro.html" data-v-e6005420>Introduction</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/devdocs/devGuide/bootcamp/exploreMarkBind.html" data-v-e6005420>Explore MarkBind as a User</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/devdocs/devGuide/bootcamp/contributeToDocs.html" data-v-e6005420>Contribute to Documentation</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/devdocs/devGuide/bootcamp/fixABug.html" data-v-e6005420>Fix a Bug</a></div></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-1" data-v-e6005420><a href="/devdocs/devGuide/bootcamp/implementAFeature.html" data-v-e6005420>Implement a New Feature</a></div></li></ul></li> <li data-v-e6005420><div onclick="handleSiteNavClick(this)" class="site-nav-default-list-item site-nav-list-item-0" data-v-e6005420>Development

Expand All @@ -33,7 +33,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-474166ec><!----> <div class="header-and-body" data-v-474166ec><!----> <div class="box-body-wrapper" data-v-474166ec><div class="icon-wrapper text-danger" data-v-474166ec><i class="fas fa-flag" data-v-474166ec></i></div> <!----> <div class="contents" data-v-474166ec><p data-v-474166ec><strong data-v-474166ec>Checkpoint</strong></p> <p data-v-474166ec>For <span class="underline" data-v-474166ec>actual</span> documentation changes, check that the following are true:</p> <ul class="contains-task-list" data-v-474166ec><li class="task-list-item enabled" data-v-474166ec><input type="checkbox" class="task-list-item-checkbox" data-v-474166ec> The PR template has been filled in</li> <li class="task-list-item enabled" data-v-474166ec><input type="checkbox" class="task-list-item-checkbox" data-v-474166ec> 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.5.2</a> on Fri, 9 Aug 2024, 15:43:24 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.5.2</a> on Sun, 11 Aug 2024, 3:57:37 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 src="/devdocs/markbind/js/polyfill.min.js"></script>
<script src="/devdocs/markbind/js/vue.min.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion devGuide/bootcamp/contributeToDocs.page-vue-render.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 06beafc

Please sign in to comment.