Skip to content

Commit

Permalink
deploy: 1d3a21e
Browse files Browse the repository at this point in the history
  • Loading branch information
sbliven committed Oct 22, 2024
1 parent ff9fda2 commit 939c85a
Show file tree
Hide file tree
Showing 64 changed files with 2,429 additions and 3,087 deletions.
8 changes: 4 additions & 4 deletions Development/Documentation.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>Documentation · SciCat Documentation</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="HonKit 3.7.5">
<meta name="generator" content="HonKit 5.1.4">



Expand Down Expand Up @@ -1011,11 +1011,11 @@ <h1 id="documentation">Documentation</h1>
<h2 id="overview">Overview</h2>
<p>The documentation consists of three main parts.</p>
<ul>
<li>The &quot;Home Webgpage&quot; of the project , describing the purpose and use cases for the software. The source is located at <a href="https://github.com/SciCatProject/scicatproject.github.io" target="_blank">https://github.com/SciCatProject/scicatproject.github.io</a> </li>
<li>The "Home Webgpage" of the project , describing the purpose and use cases for the software. The source is located at <a href="https://github.com/SciCatProject/scicatproject.github.io" target="_blank">https://github.com/SciCatProject/scicatproject.github.io</a> </li>
<li>The documentation proper, split into User,Operator,Ingestor and Developer manual. The source is located at <a href="https://github.com/SciCatProject/documentation" target="_blank">https://github.com/SciCatProject/documentation</a> . It covers all components of the software, i.e frontend and backend. The documentation tool <a href="https://honkit.netlify.app/" target="_blank">honkit</a> (successor of gitbook) is used.</li>
<li>The documentation of the REST API of the backend. This is generated from the swagger.json file, which itself is generated from the model descriptions in loopback</li>
</ul>
<p>All parts are hosted on the <a href="https://pages.github.com/" target="_blank">GitHub Pages platform</a>. The documentation part is &quot;injected&quot; into the GitHub pages automatically by a travis job, which runs after each commit to the documentation repository</p>
<p>All parts are hosted on the <a href="https://pages.github.com/" target="_blank">GitHub Pages platform</a>. The documentation part is "injected" into the GitHub pages automatically by a travis job, which runs after each commit to the documentation repository</p>
<p>The live web site is then visible on the following URLs respectively</p>
<ul>
<li><a href="https://scicatproject.github.io/" target="_blank">https://scicatproject.github.io/</a></li>
Expand Down Expand Up @@ -1094,7 +1094,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Documentation","level":"1.5.3","depth":2,"previous":{"title":"Migration v3.x to v4.x","level":"1.5.2.9","depth":3,"path":"Development/v4.x/Migration.md","ref":"Development/v4.x/Migration.md","articles":[]},"dir":"ltr"},"config":{"plugins":["chapter-fold","mermaid-gb3"],"styles":{"website":"styles/website.css"},"pluginsConfig":{"chapter-fold":{},"mermaid-gb3":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56},"embedFonts":false},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"SciCat Documentation","gitbook":"*"},"file":{"path":"Development/Documentation.md","mtime":"2024-08-23T11:57:34.567Z","type":"markdown"},"gitbook":{"version":"3.7.5","time":"2024-08-23T11:57:40.212Z"},"basePath":"..","book":{"language":""}});
gitbook.page.hasChanged({"page":{"title":"Documentation","level":"1.5.3","depth":2,"previous":{"title":"Migration v3.x to v4.x","level":"1.5.2.9","depth":3,"path":"Development/v4.x/Migration.md","ref":"Development/v4.x/Migration.md","articles":[]},"dir":"ltr"},"config":{"plugins":["chapter-fold","mermaid-gb3"],"styles":{"website":"styles/website.css"},"pluginsConfig":{"chapter-fold":{},"mermaid-gb3":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56},"embedFonts":false},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"SciCat Documentation","gitbook":"*"},"file":{"path":"Development/Documentation.md","mtime":"2024-10-22T13:28:07.172Z","type":"markdown"},"gitbook":{"version":"5.1.4","time":"2024-10-22T13:28:11.761Z"},"basePath":"..","book":{"language":""}});
});
</script>
</div>
Expand Down
4 changes: 2 additions & 2 deletions Development/index.html

Large diffs are not rendered by default.

Loading

0 comments on commit 939c85a

Please sign in to comment.