Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

reorganize documentation - add github pages #467

Merged
merged 6 commits into from
Aug 5, 2022
Merged

reorganize documentation - add github pages #467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0e043cc
Set theme jekyll-theme-minimal
Aug 4, 2022
108edb5
move all documentation into the subdir
Aug 4, 2022
8559fd0
added link to the github pages in the page header
Aug 4, 2022
1a15cef
point to the full documentation
Aug 4, 2022
1e60c0f
simplify the page title
Aug 4, 2022
9a35161
correct for the extra space of the documentation icon
Aug 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion _config.yml
View file
Open in desktop

This file was deleted.

0 CONTRIBUTING.md → docs/CONTRIBUTING.md
View file
Open in desktop
File renamed without changes.
0 LICENSE.md → docs/LICENSE.md
View file
Open in desktop
File renamed without changes.
8 changes: 5 additions & 3 deletions README.md → docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# SaltGUI

A new open source web interface for managing a SaltStack server. Built using vanilla ES6 and implemented as a wrapper around the rest_cherrypy server.
SaltGUI is an open source web interface for managing a SaltStack server and its minions. Built using vanilla ES6 and implemented as a wrapper around the rest_cherrypy server a.k.a. salt-api.

The version tagged `release` is the latest released version. The version `master` should be fine, but it may contain changes that are not yet in these release-notes.

See [SaltGUI documentation](https://erwindon.github.io/SaltGUI/) for the complete documentation.


## Screenshots
![overview](/docs/screenshots/overview.png)
![overview](screenshots/overview.png)

![job](/docs/screenshots/job.png)
![job](screenshots/job.png)


## Features
Expand Down
2 changes: 2 additions & 0 deletions docs/_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
theme: jekyll-theme-minimal
title: ""
9 changes: 6 additions & 3 deletions saltgui/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,16 @@
<body>
<header id="header">
<h1 id="logo" class='logo'>SaltGUI</h1>
<!-- full menu -->
<div class="fullmenu"></div>
<!-- mini menu -->
<svg class='fab' width="36" height="36">
<circle id='button-manual-run' cx="18" cy="18" r="18" fill="#4caf50" />
<text style='pointer-events: none' fill="white" font-weight="bold" font-size="20" x="6" y="23">&gt;_</text>
</svg>
<!-- 1F4D6 = A BOOK -->
<!-- FE0E = VARIATION SELECTOR-15 (render as text) -->
<h1 id="docu" class='docu'>&#x1F4D6;&#xFE0E;</h1>
<!-- full menu -->
<div class="fullmenu"></div>
<!-- mini menu -->
<div class="minimenu">
<div class="dropdown">
<!-- 2261 = MATHEMATICAL OPERATOR IDENTICAL TO (aka "hamburger") -->
Expand Down
6 changes: 6 additions & 0 deletions saltgui/static/scripts/Router.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,12 @@ export class Router {
pClickEvent.stopPropagation();
});

document.getElementById("docu").
addEventListener("click", (pClickEvent) => {
window.open("https://erwindon.github.io/SaltGUI/", "_blank");
pClickEvent.stopPropagation();
});

addEventListener("popstate", (popstate) => {
const hash = popstate.target.location.hash.replace(/^#/, "");
const search = popstate.target.location.search;
Expand Down
27 changes: 24 additions & 3 deletions saltgui/static/stylesheets/main.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,27 @@ header {
user-select: none;
}

.docu {
cursor: pointer;
color: gray;
font-size: 30px;
font-weight: normal;
display: inline-block;
float: right;
padding: 10px 20px;

/* prevent text selection */
-webkit-user-select: none;
-khtml-user-select: none;
-moz-user-select: none;
-o-user-select: none;
user-select: none;
}

.docu:hover {
color: #4caf50;
}

h1 {
color: #4caf50;
font-weight: lighter;
Expand All @@ -61,7 +82,7 @@ h1 {
margin-left: 0;
}

@media (max-width: 900px) {
@media (max-width: 950px) {
.panel {
margin-left: 0;
}
Expand Down Expand Up @@ -161,12 +182,12 @@ h1 {
cursor: pointer;
}

@media (min-width: 900px) {
@media (min-width: 950px) {
.fullmenu { display: inline-block; }
.minimenu { display: none; }
}

@media (max-width: 900px) {
@media (max-width: 950px) {
.fullmenu { display: none; }
.minimenu { display: inline-block; }
}
Expand Down
2 changes: 1 addition & 1 deletion saltgui/static/stylesheets/page.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ table tr td:last-of-type {
flex-grow: 1;
}

@media (max-width: 900px) {
@media (max-width: 950px) {
.minions {
min-width: 0;
}
Expand Down