Skip to content
This repository has been archived by the owner on Jul 24, 2024. It is now read-only.

fix #88 Migrate Developer Handbook #107

Merged
merged 42 commits into from
Nov 15, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
d55b750
Rebuilding
kahboom Oct 24, 2018
d6968ba
Set up dirs for Dev Handbook
kahboom Nov 12, 2018
c2821d5
Move to individual files, not directories
kahboom Nov 12, 2018
8231da6
Add sidebar and top nav for docs
kahboom Nov 12, 2018
add6bd3
Rename from Docs to Developer Docs, for clarity
kahboom Nov 12, 2018
792d4ec
Update to use proper archetype and SCSS specifically for docs
kahboom Nov 12, 2018
92e6ba7
fix #63 table styling
kahboom Nov 12, 2018
db35090
Make tables adjust to full width of screen
kahboom Nov 12, 2018
505eb83
Fix issue where empty table headers are not hidden
kahboom Nov 12, 2018
f6f8d21
Update table content
kahboom Nov 12, 2018
fd7b495
Icon adj
kahboom Nov 13, 2018
8ea6411
Adj weight menus for list ordering, top and side nav
kahboom Nov 13, 2018
a57e40c
Fix commands table
kahboom Nov 13, 2018
174c2d7
Fix pre styling
kahboom Nov 13, 2018
c00586a
Update italic title
kahboom Nov 13, 2018
41e4aad
Darken code blocks for Docs section
kahboom Nov 13, 2018
e007468
Add remaining content for CLI page
kahboom Nov 13, 2018
bc6c5e2
Add modules table
kahboom Nov 13, 2018
d95e5f8
Fix table
kahboom Nov 13, 2018
7025d69
Fix table, though eventually should only hide empty cells in thead
kahboom Nov 13, 2018
ab143be
Reformat minishift, ui, build to md
kahboom Nov 14, 2018
ae0a593
Reformat syndesis dev for md
kahboom Nov 14, 2018
1e71ba5
Reformat syndesis_doc for md
kahboom Nov 14, 2018
f5eefbd
Reformat syndesis_release for md
kahboom Nov 14, 2018
632e729
Reformat syndesis_install for md
kahboom Nov 14, 2018
4301645
Styling changes for h3
kahboom Nov 14, 2018
5a3df0a
Adj padding for header tags
kahboom Nov 14, 2018
fbadfe2
Only hide empty cells in thead
kahboom Nov 14, 2018
6b37654
Fix first h2
kahboom Nov 14, 2018
e7c0e2b
Minor changes
kahboom Nov 14, 2018
e0a04dd
Fix headers in main SCSS file
kahboom Nov 14, 2018
672a079
Minor changes
kahboom Nov 14, 2018
58dc44c
Move index
kahboom Nov 14, 2018
8877fba
Use docs SCSS for headers
kahboom Nov 14, 2018
9c0ab19
Note to use sidebar to navigate
kahboom Nov 15, 2018
4e09144
Add Development section, Maven Groups
kahboom Nov 15, 2018
dfecbdd
Add Issue Labels
kahboom Nov 15, 2018
8bf837f
Add Local section
kahboom Nov 15, 2018
746aaed
Add UI section
kahboom Nov 15, 2018
ebc2a67
Add REST API section
kahboom Nov 15, 2018
9b86f18
Add Troubleshooting section
kahboom Nov 15, 2018
1738f05
Resolve header issues
kahboom Nov 15, 2018
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
2 changes: 1 addition & 1 deletion content/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ menu:
sidenav:
name: "Community"
pre: "<i class='fa fa-fw fa-group'></i>"
weight: -180
weight: -80
topnav:
name: "community"
weight: -120
Expand Down
20 changes: 20 additions & 0 deletions content/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
draft: false
title: "Developer Docs"
description: "Documentation and guides for using and/or contributing to the Syndesis project."
sidebar: "sidenav"
kind: docs

menu:
sidenav:
name: "Developer Docs"
pre: "<i class='fa fa-fw fa-book'></i>"
weight: -180
topnav:
name: "docs"
weight: -180
---

This handbook contain all information required for installing, running and developing Syndesis from a developer's point of view.

Please use the links in the sidebar on the left to navigate the Developer Docs.
8 changes: 0 additions & 8 deletions content/docs/_index.md

This file was deleted.

1,189 changes: 1,189 additions & 0 deletions content/docs/cli.md

Large diffs are not rendered by default.

593 changes: 593 additions & 0 deletions content/docs/development.md

Large diffs are not rendered by default.

Binary file modified static/images/favicon-02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/grant.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/landing_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/orig/grant.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/orig/landing_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/orig/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/orig/security_exception.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/red-hat-02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/screenshot-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/screenshot-integration-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/security_exception.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/syndesis-group-dependencies.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/zenhub-columns.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{{ define "main"}}
<div itemscope
class="article">
class="doc">
{{ template "_internal/schema.html" .}}
<div class="hero">
<h1 itemprop="headline">{{.Title}}</h1>
{{ if .Description }}
<blockquote itemprop="description">{{ .Description }}</blockquote>
{{ end }}
</div>
<div itemprop="articleBody"
class="articleBody">
<div itemprop="docBody"
class="docBody">
{{ .Content | safeHTML }}
</div>
</div>
Expand Down
3 changes: 1 addition & 2 deletions themes/syndesis/scss/_blog.scss
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@import 'colors';
@import "colors";

////////////////////////////////////////////////////////////////////////////////
// BLOG
Expand Down Expand Up @@ -36,4 +36,3 @@
}
}
}

32 changes: 30 additions & 2 deletions themes/syndesis/scss/_docs.scss
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,33 @@
// DOCS
////////////////////////////////////////////////////////////////////////////////

@import 'colors';
@import 'navbar';
@import "colors";
@import "navbar";
@import "./bootstrap/_variables";
@import "../../../node_modules/bootstrap/scss/bootstrap";

@import "colors";
@import "highlighting";

.docs {
.docBody {
h2 {
font-size: 1.75rem;
padding: 35px 0 10px;

&:first-of-type {
padding: 15px 0;
}
}

h3 {
color: $pf-blue;
font-size: 1.3em;
padding: 15px 0 10px;
}

pre {
background: #f7f7f8 !important;
}
}
}
2 changes: 1 addition & 1 deletion themes/syndesis/scss/_sidenav.scss
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
ul.sidebar-menu {
padding: 0;
margin: -2px 0 0;
background-color: #eeeeee;
//background-color: #eeeeee;

li {

Expand Down
106 changes: 89 additions & 17 deletions themes/syndesis/scss/syndesis.scss
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
@import './bootstrap/_variables';
@import '../../../node_modules/bootstrap/scss/bootstrap';

@import 'blog';
@import 'colors';
@import 'docs';
@import 'footer';
@import 'github-corner';
@import 'home';
@import 'icons';
@import 'navbar';
@import 'sidenav';
@import 'toc';
@import 'highlighting';

html, body {
@import "./bootstrap/_variables";
@import "../../../node_modules/bootstrap/scss/bootstrap";

@import "blog";
@import "colors";
@import "docs";
@import "footer";
@import "github-corner";
@import "home";
@import "icons";
@import "navbar";
@import "sidenav";
@import "toc";
@import "highlighting";

html,
body {
height: 100%;
width: 100%;
}
Expand All @@ -39,6 +40,78 @@ html, body {
@include media-breakpoint-up(lg) {
width: calc(100% - 214px - 314px);
}

h2 {
font-size: 1.75rem;
padding: 35px 0 10px;

&:first-of-type {
padding: 15px 0;
}
}

h3 {
color: $pf-blue;
font-size: 1.3em;
padding: 15px 0 10px;
}

pre {
background: #f7f7f8 !important;
}
}

table {
//display: block;
display: table;
border-collapse: collapse;
//border-collapse: separate;
border-color: grey;
border-spacing: 2px;
empty-cells: hide;
line-height: 1.5;
margin-bottom: 1.5rem;
overflow: auto;
width: 100%;

thead {
display: table-header-group;
vertical-align: middle;
border-color: inherit;

th,
tr {
:empty {
display: none;
}
}
}

tbody {
display: table-row-group;
vertical-align: middle;
border-color: inherit;
}

th {
font-weight: 600;
}

tr {
background-color: #fff;
border-top: 1px solid #c6cbd1;
display: table-row;
}

tr:nth-child(2n) {
background-color: #f6f8fa;
}

td,
th {
border: 1px solid #dfe2e5;
padding: 6px 13px;
}
}
}

Expand All @@ -49,4 +122,3 @@ html, body {
height: 100px;
visibility: hidden;
}