-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to gh-pages from @ fe100f1 🚀
- Loading branch information
Showing
7 changed files
with
143 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,6 +8,7 @@ Table of Contents | |
| :caption: Getting Started | ||
| :name: start | ||
|
|
||
| intro | ||
| installation | ||
| first_run | ||
| implementation | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| Ontobot is a GitHub-based bot for making ontology change requests in KGCL, the Knowledge Graph Change Language. | ||
| It can be installed in a GitHub ontology repository, where it then watches for issues that include a specific text string: “Hey ontobot!, apply:” | ||
| When it sees that string, Ontobot scans the issue for a bulleted list of ontology change requests, written in the KGCL syntax. | ||
| Ontobot reads the list of one or more KGCL commands, and automatically generates a GitHub Pull Request that will make the requested change(s) in the ontology source file. | ||
|
|
||
| Ontobo workflows are defined using YAML files, and placed in a directory called ‘.github/workflows’ within the repository. | ||
| The Ontobot manual provides YAML templates, which can be downloaded, customized, and added to the GitHub repository where your ontology source file is maintained: | ||
| .github/workflows/ontobot.yaml. | ||
|
|
||
| KGCL can express common ontology editing operations (such as modifying a label or a definition, obsoleting a term, moving a term under another parent term, etc.) | ||
| using a syntax as close as possible to natural English language. | ||
| As an example, the KGCL command to change the name of the ontology term with the ID ENVO:01000575 from ‘wax’ to ‘oil’ is “rename ENVO:01000575 from ‘wax’ to ‘oil’”. | ||
|
|
||
| The grammar defining KGCL can be found at https://github.com/INCATools/kgcl/blob/main/src/kgcl_schema/grammar/kgcl.lark. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| <!DOCTYPE html> | ||
| <html class="writer-html5" lang="en" > | ||
| <head> | ||
| <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> | ||
|
|
||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title><no title> — ontobot-change-agent 0.0.0 documentation</title> | ||
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> | ||
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> | ||
| <!--[if lt IE 9]> | ||
| <script src="_static/js/html5shiv.min.js"></script> | ||
| <![endif]--> | ||
|
|
||
| <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> | ||
| <script src="_static/jquery.js"></script> | ||
| <script src="_static/underscore.js"></script> | ||
| <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> | ||
| <script src="_static/doctools.js"></script> | ||
| <script src="_static/sphinx_highlight.js"></script> | ||
| <script src="_static/js/theme.js"></script> | ||
| <link rel="index" title="Index" href="genindex.html" /> | ||
| <link rel="search" title="Search" href="search.html" /> | ||
| <link rel="next" title="Installation" href="installation.html" /> | ||
| <link rel="prev" title="Documentation" href="index.html" /> | ||
| </head> | ||
|
|
||
| <body class="wy-body-for-nav"> | ||
| <div class="wy-grid-for-nav"> | ||
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> | ||
| <div class="wy-side-scroll"> | ||
| <div class="wy-side-nav-search" > | ||
|
|
||
|
|
||
|
|
||
| <a href="index.html" class="icon icon-home"> | ||
| ontobot-change-agent | ||
| </a> | ||
| <div role="search"> | ||
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> | ||
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> | ||
| <input type="hidden" name="check_keywords" value="yes" /> | ||
| <input type="hidden" name="area" value="default" /> | ||
| </form> | ||
| </div> | ||
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> | ||
| <p class="caption" role="heading"><span class="caption-text">Getting Started</span></p> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="first_run.html">First Run</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="implementation.html">Implementation</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="developers.html">For Developers</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="cli.html">Command Line Interface</a></li> | ||
| </ul> | ||
|
|
||
| </div> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > | ||
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| <a href="index.html">ontobot-change-agent</a> | ||
| </nav> | ||
|
|
||
| <div class="wy-nav-content"> | ||
| <div class="rst-content"> | ||
| <div role="navigation" aria-label="Page navigation"> | ||
| <ul class="wy-breadcrumbs"> | ||
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> | ||
| <li class="breadcrumb-item active"><no title></li> | ||
| <li class="wy-breadcrumbs-aside"> | ||
| <a href="_sources/intro.rst.txt" rel="nofollow"> View page source</a> | ||
| </li> | ||
| </ul> | ||
| <hr/> | ||
| </div> | ||
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||
| <div itemprop="articleBody"> | ||
|
|
||
| <p>Ontobot is a GitHub-based bot for making ontology change requests in KGCL, the Knowledge Graph Change Language. | ||
| It can be installed in a GitHub ontology repository, where it then watches for issues that include a specific text string: “Hey ontobot!, apply:” | ||
| When it sees that string, Ontobot scans the issue for a bulleted list of ontology change requests, written in the KGCL syntax. | ||
| Ontobot reads the list of one or more KGCL commands, and automatically generates a GitHub Pull Request that will make the requested change(s) in the ontology source file.</p> | ||
| <p>Ontobo workflows are defined using YAML files, and placed in a directory called ‘.github/workflows’ within the repository. | ||
| The Ontobot manual provides YAML templates, which can be downloaded, customized, and added to the GitHub repository where your ontology source file is maintained: | ||
| .github/workflows/ontobot.yaml.</p> | ||
| <p>KGCL can express common ontology editing operations (such as modifying a label or a definition, obsoleting a term, moving a term under another parent term, etc.) | ||
| using a syntax as close as possible to natural English language. | ||
| As an example, the KGCL command to change the name of the ontology term with the ID ENVO:01000575 from ‘wax’ to ‘oil’ is “rename ENVO:01000575 from ‘wax’ to ‘oil’”.</p> | ||
| <p>The grammar defining KGCL can be found at <a class="reference external" href="https://github.com/INCATools/kgcl/blob/main/src/kgcl_schema/grammar/kgcl.lark">https://github.com/INCATools/kgcl/blob/main/src/kgcl_schema/grammar/kgcl.lark</a>.</p> | ||
|
|
||
|
|
||
| </div> | ||
| </div> | ||
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> | ||
| <a href="index.html" class="btn btn-neutral float-left" title="Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | ||
| <a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> | ||
| </div> | ||
|
|
||
| <hr/> | ||
|
|
||
| <div role="contentinfo"> | ||
| <p>© Copyright 2024, Harshad Hegde.</p> | ||
| </div> | ||
|
|
||
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a | ||
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> | ||
| provided by <a href="https://readthedocs.org">Read the Docs</a>. | ||
|
|
||
|
|
||
| </footer> | ||
| </div> | ||
| </div> | ||
| </section> | ||
| </div> | ||
| <script> | ||
| jQuery(function () { | ||
| SphinxRtdTheme.Navigation.enable(true); | ||
| }); | ||
| </script> | ||
|
|
||
| </body> | ||
| </html> |
Binary file not shown.
Oops, something went wrong.