Skip to content

Commit 26c9669

Browse files
tosin2013tosin2013
authored
Merge pull request #11 from tosin2013/main
Creating needed githubpage
2 parents 0c72405 + 1239501 commit 26c9669

71 files changed

Lines changed: 8775 additions & 67 deletions

File tree

Some content is hidden

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

‎.github/workflows/jekyll-build.yml‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
name: Build Jekyll site
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- '.github/workflows/jekyll-build.yml'
10+
pull_request:
11+
branches:
12+
- main
13+
paths:
14+
- 'docs/**'
15+
- '.github/workflows/jekyll-build.yml'
16+
17+
# Allow only one concurrent deployment
18+
concurrency:
19+
group: "pages"
20+
cancel-in-progress: true
21+
22+
# Sets permissions of the GITHUB_TOKEN
23+
permissions:
24+
contents: read
25+
pages: write
26+
id-token: write
27+
28+
jobs:
29+
build:
30+
runs-on: ubuntu-latest
31+
environment:
32+
name: github-pages
33+
url: ${{ steps.deployment.outputs.page_url }}
34+
35+
steps:
36+
- name: Checkout repository
37+
uses: actions/checkout@v4
38+
39+
- name: Setup Ruby
40+
uses: ruby/setup-ruby@v1
41+
with:
42+
ruby-version: '3.2'
43+
bundler-cache: true
44+
working-directory: docs
45+
46+
- name: Cache dependencies
47+
uses: actions/cache@v3
48+
with:
49+
path: |
50+
docs/vendor/bundle
51+
docs/_site
52+
docs/.jekyll-cache
53+
key: ${{ runner.os }}-jekyll-${{ hashFiles('docs/Gemfile.lock', 'docs/_config.yml') }}
54+
restore-keys: |
55+
${{ runner.os }}-jekyll-
56+
57+
- name: Install dependencies
58+
working-directory: docs
59+
run: |
60+
bundle config path vendor/bundle
61+
bundle install --jobs 4 --retry 3
62+
63+
- name: Check Jekyll configuration
64+
working-directory: docs
65+
run: bundle exec jekyll doctor
66+
67+
- name: Build Jekyll site
68+
working-directory: docs
69+
run: |
70+
JEKYLL_ENV=production bundle exec jekyll build --trace
71+
env:
72+
JEKYLL_ENV: production
73+
74+
- name: Test site output
75+
working-directory: docs
76+
run: |
77+
test -d _site
78+
test -f _site/index.html
79+
80+
- name: Upload artifact
81+
uses: actions/upload-pages-artifact@v3
82+
with:
83+
path: docs/_site/
84+
85+
- name: Deploy to GitHub Pages
86+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
87+
id: deployment
88+
uses: actions/deploy-pages@v4
89+
with:
90+
token: ${{ secrets.GITHUB_TOKEN }}
91+
92+
- name: Verify deployment
93+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
94+
run: |
95+
# Wait for deployment to complete
96+
sleep 30
97+
# Verify the site is accessible
98+
curl -sSf ${{ steps.deployment.outputs.page_url }} || exit 1

‎.gitignore‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,21 @@ playbooks/generated_manifests/
55
clusters/**
66
playbooks/generated_manifests/**
77
.vscode/
8-
.vscode/**
8+
.vscode/**
9+
cline_docs/
10+
hack/freeipa_vars.sh
11+
12+
# Jekyll specific files
13+
docs/_site/
14+
docs/_site/**
15+
docs/.jekyll-cache/
16+
docs/.jekyll-cache/**
17+
docs/vendor/
18+
docs/vendor/**
19+
docs/.bundle/
20+
docs/.bundle/**
21+
docs/.sass-cache/
22+
docs/.sass-cache/**
23+
.jekyll-metadata
24+
*~
25+
.DS_Store

‎CONTRIBUTING.md‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
# Contributing to OpenShift Agent Install Helper
2+
3+
Thank you for your interest in contributing to the OpenShift Agent Install Helper project! This document provides a quick overview of the contribution process.
4+
5+
## Repository Overview
6+
7+
Please read our [README.md](README.md) first to understand:
8+
- Project purpose and scope
9+
- Key components and utilities
10+
- Prerequisites and dependencies
11+
- Basic usage instructions
12+
13+
## Repository Structure
14+
15+
```
16+
openshift-agent-install/
17+
├── README.md # Main project documentation
18+
├── get-rhcos-iso.sh # RHCOS ISO download utility
19+
├── download-openshift-cli.sh # OpenShift CLI download utility
20+
├── disconnected-info.md # Disconnected installation guide
21+
├── docs/ # Documentation website
22+
├── examples/ # Example configurations
23+
│ ├── baremetal-example/
24+
│ ├── vmware-example/
25+
│ └── sno-examples/
26+
├── playbooks/ # Ansible automation
27+
├── scripts/ # Utility scripts
28+
├── e2e-tests/ # End-to-end tests
29+
├── hack/ # Development scripts
30+
└── site-config/ # Site configuration
31+
32+
```
33+
34+
## Quick Start for Contributors
35+
36+
1. Read the [README.md](README.md) thoroughly
37+
2. Fork the repository
38+
3. Clone your fork:
39+
```bash
40+
git clone https://github.com/YOUR_USERNAME/openshift-agent-install.git
41+
cd openshift-agent-install
42+
```
43+
4. Create a feature branch:
44+
```bash
45+
git checkout -b feature/your-feature-name
46+
```
47+
48+
## Development Prerequisites
49+
50+
As specified in README.md:
51+
- RHEL/CentOS system
52+
- OpenShift CLI tools (`./download-openshift-cli.sh`)
53+
- NMState CLI (`dnf install nmstate`)
54+
- Ansible Core (`dnf install ansible-core`)
55+
- Red Hat OpenShift Pull Secret
56+
57+
For documentation work:
58+
- Ruby 3.2+ and Bundler (see docs/README.md)
59+
60+
## Making Changes
61+
62+
### For Code Changes
63+
1. Follow the examples in the `examples/` directory
64+
2. Use the playbooks in `playbooks/` as templates
65+
3. Add tests in `e2e-tests/` for new features
66+
4. Update relevant documentation
67+
68+
### For Documentation
69+
1. Website changes go in `docs/`
70+
2. Core project documentation updates in:
71+
- README.md
72+
- disconnected-info.md
73+
- Example READMEs
74+
75+
## Testing Your Changes
76+
77+
1. For code changes:
78+
```bash
79+
# Run end-to-end tests
80+
cd e2e-tests
81+
./run-tests.sh
82+
83+
# Test specific playbooks
84+
cd playbooks
85+
ansible-playbook your-playbook.yml
86+
```
87+
88+
2. For documentation:
89+
```bash
90+
# Test documentation site
91+
cd docs
92+
bundle exec jekyll serve
93+
```
94+
95+
## Pull Request Process
96+
97+
1. Update README.md if you've added:
98+
- New prerequisites
99+
- New scripts or utilities
100+
- Changed core functionality
101+
- Added new examples
102+
103+
2. Ensure your PR includes:
104+
- Reference to relevant issues
105+
- Updates to README.md (if needed)
106+
- Updates to example configurations (if needed)
107+
- New or updated tests
108+
109+
3. PR Description Template:
110+
```markdown
111+
## Description
112+
Brief description of changes
113+
114+
## Changes to README.md
115+
- [ ] No changes needed
116+
- [ ] Updated prerequisites
117+
- [ ] Updated usage instructions
118+
- [ ] Added new feature documentation
119+
120+
## Testing Done
121+
Describe testing performed
122+
123+
## Related Issues
124+
Fixes #issue_number
125+
```
126+
127+
## Getting Help
128+
129+
1. Check the [README.md](README.md) first
130+
2. Look for similar examples in `examples/`
131+
3. Check existing issues and discussions
132+
4. Open a new issue if needed
133+
134+
## Additional Documentation
135+
136+
For comprehensive documentation, including:
137+
- Detailed guides
138+
- Architecture decisions
139+
- Advanced configurations
140+
- Best practices
141+
142+
Visit our [documentation website](https://your-org.github.io/openshift-agent-install/).
143+
144+
## Code of Conduct
145+
146+
This project follows the OpenShift community code of conduct. By participating, you are expected to uphold this code.

‎docs/Gemfile‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
source "https://rubygems.org"
2+
3+
# Use the same version of Jekyll as GitHub Pages
4+
gem "jekyll", "~> 3.9.3"
5+
gem "webrick", "~> 1.8"
6+
gem "github-pages", "~> 228"
7+
8+
group :jekyll_plugins do
9+
gem "jekyll-remote-theme"
10+
gem "jekyll-seo-tag"
11+
gem "kramdown-parser-gfm"
12+
end

0 commit comments

Comments
 (0)