This repository has been archived by the owner on Jun 28, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(build): issues/28 docs build setup and repo restructure (#37)
* ccs, adding asciidoc conversion * ccs, updating master to include QPC concepts * ccs, adding QPC concepts conversions * ccs, snapshot for doc experiments * ccs, added final includes, and files via upload * build, GitHub PR and Issue templates * build, src directory layout * build, remove asciidoc-conversion directory * build, clean up symlinks, dist, locale script * build, Readme, yarn install, badge updates, remove RST
- Loading branch information
Showing
144 changed files
with
10,096 additions
and
46 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 |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Editor configuration, see http://editorconfig.org | ||
root = true | ||
|
||
[*] | ||
charset = utf-8 | ||
indent_style = space | ||
indent_size = 2 | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
[*.md] | ||
max_line_length = off | ||
trim_trailing_whitespace = false |
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,57 @@ | ||
{ | ||
"env": { | ||
"browser": true, | ||
"es6": true, | ||
"node": true | ||
}, | ||
"plugins": [ | ||
"json", | ||
"node", | ||
"prettier" | ||
], | ||
"extends": [ | ||
"eslint:recommended", | ||
"plugin:node/recommended", | ||
"plugin:prettier/recommended" | ||
], | ||
"parserOptions":{ | ||
"ecmaVersion": 2018 | ||
}, | ||
"rules": { | ||
"arrow-parens": [ | ||
"error", | ||
"as-needed" | ||
], | ||
"comma-dangle": 0, | ||
"max-len": [ | ||
"error", | ||
{ | ||
"code": 240, | ||
"ignoreUrls": true | ||
} | ||
], | ||
"no-console": 0, | ||
"no-debugger": 1, | ||
"no-plusplus": 0, | ||
"node/no-unsupported-features/es-syntax": 1, | ||
"node/shebang": 0, | ||
"node/no-unpublished-bin": 0, | ||
"padded-blocks": 0, | ||
"prettier/prettier": [ | ||
"error", | ||
{ | ||
"singleQuote": true, | ||
"printWidth": 100 | ||
} | ||
], | ||
"space-before-function-paren": 0, | ||
"valid-jsdoc": [ | ||
1, | ||
{ | ||
"requireParamDescription": false, | ||
"requireReturnDescription": false, | ||
"requireReturn": false | ||
} | ||
] | ||
} | ||
} |
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,28 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
|
||
--- | ||
|
||
## Bug Description: | ||
<!-- Provide a description of the issue being raised. --> | ||
|
||
### Expected behavior | ||
<!-- Describe the expected behavior for the program. --> | ||
... | ||
|
||
### Actual behavior | ||
<!-- Provide the actual behavior for the program. --> | ||
... | ||
|
||
### Steps to reproduce | ||
<!-- List clear steps to reproduce the bug. --> | ||
1. | ||
1. | ||
|
||
## Additional Context | ||
<!-- Append a demo/screenshot/animated gif of the problem --> | ||
|
||
### Version Information | ||
<!-- Package.json version, tag, or git commit information. --> | ||
... |
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,27 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
|
||
--- | ||
|
||
## Feature description | ||
As user X, I want Y to happen so that Z. | ||
|
||
### Is your feature request related to a problem? | ||
<!-- Provide a clear, concise description of what the problem is. Ex. I'm always frustrated when... --> | ||
... | ||
|
||
### Describe the solution you'd like | ||
<!-- A clear and concise description of what you want to happen. --> | ||
... | ||
___ | ||
|
||
## Acceptance Criteria | ||
- [ ] Verify that users can X Y Z | ||
|
||
___ | ||
|
||
## Additional context | ||
<!-- Add any other context. Is there an associated storyboard? Attach the link/png/screenshot --> | ||
... | ||
|
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,20 @@ | ||
## What's included | ||
<!-- Summary of changes/additions --> | ||
... | ||
|
||
<!-- ### Notes --> | ||
<!-- Any issues that aren't resolved by this merge request, or things of note? --> | ||
|
||
<!-- ## How to test -- > | ||
<!-- Are there directions to test/review? --> | ||
<!-- | ||
### Basic linting check | ||
1. update the NPM packages with `$ npm install` or `$ yarn` | ||
1. `$ npm test` or `$ yarn test` | ||
--> | ||
|
||
<!-- ## Example --> | ||
<!-- Append a demo/screenshot/animated gif of the solution --> | ||
|
||
## Updates issue/story | ||
<!-- What issue/story does this update, i.e Updates #33 --> |
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,6 @@ | ||
* | ||
!package.json | ||
!dist/**/* | ||
!LICENSE | ||
!AUTHORS.rst | ||
!README.rst |
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 @@ | ||
package-lock = false |
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 @@ | ||
package.json |
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,11 @@ | ||
language: node_js | ||
|
||
cache: yarn | ||
|
||
jobs: | ||
include: | ||
- stage: test | ||
env: | ||
- NAME=yarn | ||
node_js: "10" | ||
script: yarn build && yarn test |
File renamed without changes.
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,25 @@ | ||
def qpc_version = "0.0.47" | ||
|
||
node('f28-os') { | ||
stage('Install') { | ||
sh "sudo dnf -y install origin-clients nodejs" | ||
checkout scm | ||
sh "sudo setenforce 0" | ||
} | ||
stage('Build Setup') { | ||
sh "node -v" | ||
sh "npm -v" | ||
sh "sudo npm install -g n" | ||
sh "sudo n lts" | ||
sh "node -v" | ||
sh "npm -v" | ||
sh "sudo npm install yarn -g" | ||
sh "yarn --non-interactive" | ||
} | ||
stage ('Test Client') { | ||
sh "yarn test" | ||
} | ||
stage('Build Client') { | ||
sh "yarn build" | ||
} | ||
} |
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,95 @@ | ||
[![GitHub license](https://img.shields.io/github/license/quipucords/quipudocs.svg)](https://github.com/quipucords/quipudocs/blob/master/LICENSE) | ||
[![Updates](https://pyup.io/repos/github/quipucords/quipudocs/shield.svg)](https://pyup.io/repos/github/quipucords/quipudocs/) | ||
[![Python 3](https://pyup.io/repos/github/quipucords/quipudocs/python-3-shield.svg)](https://pyup.io/repos/github/quipucords/quipudocs/) | ||
[![Documentation Status](https://readthedocs.org/projects/quipucords/badge/)](https://quipucords.readthedocs.io/en/latest/) | ||
[![Build Status](https://travis-ci.org/quipucords/quipudocs.svg?branch=master)](https://travis-ci.org/quipucords/quipudocs) | ||
|
||
# quipudocs - Documentation for Quipucords | ||
|
||
This `README` file contains information about the installation and development of quipudocs. | ||
|
||
- [Introduction to quipudocs](#intro) | ||
- [Development](#development) | ||
- [Authors](#authors) | ||
- [Copyright and License](#copyright) | ||
|
||
|
||
## <a name="intro"></a> Introduction to quipudocs | ||
quipudocs is `sphinx` based information documentation. | ||
|
||
|
||
## <a name="development"></a> Development | ||
|
||
### Read the Docs | ||
To work with the quipudocs code, begin by cloning the repository: | ||
``` | ||
$ git clone git@github.com:quipucords/quipudocs.git | ||
$ cd ./quipudocs | ||
$ pipenv shell | ||
$ pip install -r requirements.txt | ||
$ make html | ||
``` | ||
|
||
### Asciidoc | ||
The requirements for working with Asciidoc | ||
- Your system needs to be running [NodeJS version 10+](https://nodejs.org/) | ||
- [Yarn 1.13+](https://yarnpkg.com) for dependency and script management | ||
- and [Docker](https://docs.docker.com/engine/installation/) | ||
|
||
To work with Yarn you can use NPM, or if you're on a Mac, use [Homebrew](https://brew.sh/) to do the installation | ||
- NPM | ||
``` | ||
$ npm install -g yarn | ||
``` | ||
- Homebrew | ||
``` | ||
$ brew update | ||
$ brew install yarn | ||
``` | ||
|
||
|
||
To work with the Asciidoc Help guides, begin by cloning the repository: | ||
``` | ||
$ git clone git@github.com:quipucords/quipudocs.git | ||
$ cd ./quipudocs | ||
$ yarn | ||
$ yarn start | ||
``` | ||
|
||
### Build Asciidoc | ||
To build everything, the EA and the Asciidoc Help guides: | ||
``` | ||
$ yarn build | ||
``` | ||
|
||
But you can also run each Help guide build separately: | ||
``` | ||
$ yarn build:discovery-install | ||
$ yarn build:qpc-install | ||
$ yarn build:discovery-user | ||
$ yarn build:qpc-user | ||
``` | ||
|
||
And run the EA build separately: | ||
``` | ||
$ yarn build:locale | ||
``` | ||
|
||
### Test Asciidoc | ||
To run basic linting checks on HTML, JSON, and JS files for the EA and Asciidoc Help guides: | ||
``` | ||
$ yarn test | ||
``` | ||
|
||
Asciidoctor contains a compiler check that processes when the build is run. We leverage this compiler check during our CI process as an additional "test". | ||
|
||
## <a name="authors"></a> Authors | ||
Authorship and current maintainer information can be found in [AUTHORS](AUTHORS.MD). | ||
|
||
|
||
## <a name="copyright"></a> Copyright and License | ||
Copyright 2017-2019, Red Hat, Inc. | ||
|
||
|
||
quipudocs is released under the [GNU Public License version 3](LICENSE). | ||
|
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.