Skip to content

Commit fc07793

Browse files
paulswitherspaulswithers
committed
Initial commit
0 parents  commit fc07793

File tree

867 files changed

+65218
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

867 files changed

+65218
-0
lines changed

‎.github/workflows/docs.yaml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Run Mkdocs Deploy
2+
3+
# Controls when the workflow will run
4+
on:
5+
# Triggers the workflow on push or pull request events but only for the main branch
6+
push:
7+
branches: [ main ]
8+
# pull_request:
9+
# branches: [ main ]
10+
11+
12+
# Triggers when a new release is published
13+
# release:
14+
# types: [released, edited]
15+
16+
# Allows you to run this workflow manually from the Actions tab
17+
workflow_dispatch:
18+
19+
20+
21+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
22+
jobs:
23+
# This workflow contains a single job called "build"
24+
build:
25+
# The type of runner that the job will run on
26+
runs-on: ubuntu-latest
27+
28+
# Steps represent a sequence of tasks that will be executed as part of the job
29+
steps:
30+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
31+
- uses: actions/checkout@v2
32+
33+
# Build and publish the site
34+
- uses: actions/setup-python@v2
35+
with:
36+
python-version: 3.x
37+
# Install python pre-reqs
38+
- name: Install Mkdocs and pre-reqs
39+
run: |
40+
pip install mkdocs-material
41+
pip install mkdocs-awesome-pages-plugin mkdocs-git-revision-date-localized-plugin mike mkdocs-markdownextradata-plugin mkdocs-git-authors-plugin mkdocs-blog-plugin mkdocs-section-index
42+
# Do the actual deployment
43+
- name: Deploy GH Pages
44+
run: |
45+
mkdocs gh-deploy --force

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# VS Code
2+
.devcontainer
3+
.devcontainerjson
4+
.vscode/
5+
6+
# MKDocs
7+
site/*

‎.markdownlint.json‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"MD007": {
3+
"indent": 4
4+
},
5+
"MD010": false,
6+
"MD013": false,
7+
"MD033": false,
8+
"MD024": false,
9+
"MD025": false,
10+
"MD034": false,
11+
"MD047": false,
12+
"MD046": false
13+
}

‎50x.html‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1" />
6+
<title>We are taking a REST</title>
7+
<style type="text/css">
8+
body {
9+
font-family: 'Jetbrains Mono', Roboto, 'Segoe UI', Tahoma, Geneva,
10+
Verdana, sans-serif;
11+
}
12+
13+
header {
14+
color: white;
15+
background-image: linear-gradient(to right, #5f1ebe, #3c91ff);
16+
height: 100px;
17+
margin: 10px 20px;
18+
border-radius: 5px;
19+
}
20+
21+
h1 {
22+
text-align: center;
23+
line-height: 100px;
24+
font-weight: normal;
25+
margin: 0;
26+
}
27+
28+
.container {
29+
font-size: xx-large;
30+
margin: 10px 20px;
31+
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.12), 0 1px 2px rgba(0, 0, 0, 0.24);
32+
transition: all 0.3s cubic-bezier(0.25, 0.8, 0.25, 1);
33+
border-radius: 8px;
34+
color: #554c4c;
35+
padding: 15px;
36+
vertical-align: middle;
37+
text-align: center;
38+
}
39+
40+
footer {
41+
color: white;
42+
background-image: linear-gradient(to right, #5f1ebe, #3c91ff);
43+
margin: 10px 20px;
44+
border-radius: 5px;
45+
padding: 10px;
46+
text-align: center;
47+
position: absolute;
48+
bottom: 5px;
49+
width: 95%;
50+
}
51+
52+
footer a {
53+
color: white;
54+
}
55+
</style>
56+
</head>
57+
<body>
58+
<header>
59+
<h1>50x happend</h1>
60+
</header>
61+
<div class="container">
62+
<p>We are sorry, upstream services are taking a REST.</p>
63+
<p>Try later and/or inform your admin, if you know who they are.</p>
64+
</div>
65+
<footer>
66+
<a href="https://github01.hclpnp.com/HCL-Janus/voltscript-mkdocs"
67+
>&copy; 2022 HCL America, Inc.
68+
</a>
69+
</footer>
70+
</body>
71+
</html>

‎CODE_OF_CONDUCT.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
Projects should foster a positive environment, to ensure active and pleasant participation for all. This is wording for a contributor covenant, amended from [Contributor Covenant 2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/).
4+
5+
## Our Pledge
6+
7+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
8+
9+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
10+
11+
## Our Standards
12+
13+
Examples of behavior that contributes to a positive environment for our community include:
14+
15+
- Demonstrating empathy and kindness toward other people
16+
- Being respectful of differing opinions, viewpoints, and experiences
17+
- Giving and gracefully accepting constructive feedback
18+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
19+
- Focusing on what is best not just for us as individuals, but for the overall community
20+
21+
Examples of unacceptable behavior include:
22+
23+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
24+
- Trolling, insulting or derogatory comments, and personal or political attacks
25+
- Public or private harassment
26+
- Publishing others’ private information, such as a physical or email address, without their explicit permission
27+
- Other conduct which could reasonably be considered inappropriate in a professional setting
28+
29+
## Enforcement Responsibilities
30+
31+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
32+
33+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
34+
35+
## Scope
36+
37+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
38+
39+
## Enforcement
40+
41+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the HCL Open Source Project Officer, who is responsible for enforcement, at [ospo.hclsoftware@hcl.com](mailto:ospo.hclsoftware@hcl.com). All complaints will be reviewed and investigated promptly and fairly. The HCL Open Source Project Office is obligated to respect the privacy and security of the reporter of any incident. Details of enforcement policies may be posted separately.
42+
43+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by the HCL Open Source Project Office.
44+
45+
## Attribution
46+
47+
This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at <a href="https://www.contributor-covenant.org/version/2/0/code_of_conduct.html">https://www.contributor-covenant.org/version/2/0/code_of_conduct.html</a>.
48+
49+
Community Impact Guidelines were inspired by Mozilla’s code of conduct enforcement ladder.
50+
51+
For answers to common questions about this code of conduct, see the FAQ at <a href="https://www.contributor-covenant.org/faq">https://www.contributor-covenant.org/faq</a>.

‎CONTRIBUTING.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing Guidelines
2+
3+
## Contributor roles
4+
5+
Open source should not be just about writing code. A good open source project also needs:
6+
7+
- Documentation writers
8+
- Testers
9+
- Tutorial writers
10+
- Evangelists
11+
- Automation builders
12+
13+
If you want to get involved in a role (including ones we may have missed!) reach out to one of the committers.
14+
15+
## Working on issues
16+
17+
- Ensure there is a GitHub issue for any bug before submitting a PR.
18+
- Enhancements should be discussed and a feature request issue created, before starting work on it.
19+
- Fork and raise a PR for work.
20+
- Add tests for any enhancements.
21+
- Ensure documentation is updated accordingly, including adding unit test reports.
22+
- Ensure API docs are updated (speak to an HCL-ite if required).
23+
- Ensure changelog is updated.
24+
25+
## Development Environment
26+
27+
- Develop code with Visual Studio Code and VoltScript extensions, see https://help.hcltechsw.com/docs/voltscript/early-access/howto/writing/index.html.
28+
- Documentation uses Material for MKDocs framework:
29+
- Write documentation in the relevant area of the docs directory.
30+
- Preview documentation using MKDocs, either [locally installed with relevant plugins](https://squidfunk.github.io/mkdocs-material/getting-started/) or using the [MKDocs HCL Container Image](https://github.com/HCL-TECH-SOFTWARE/hcl-mkdocs-build-image)
31+
32+
## Pushing unit tests to documentation
33+
34+
In a Terminal, navigate to the directory containing the `unit-tests-to-docs.sh` file. Run the file, passing two parameters - a string matching part of the filename for the tests and a new folder name to push the results to. For example, `./unit-tests-to-docs.sh TestCol* TestCollections`
35+
36+
## PRs
37+
38+
- When ready, complete a PR and submit.
39+
- Review the requirements for submitting a PR, for example writing test and updating documentation.

0 commit comments

Comments
 (0)