-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(add): integrate JTD for dedicated wiki pages hosted @ github pages
- Loading branch information
Showing
34 changed files
with
1,138 additions
and
3 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,26 @@ | ||
name: CI Product Central Wiki to Pages | ||
|
||
on: | ||
push: | ||
branches: ["main"] | ||
paths: | ||
- "docs/**" | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
defaults: | ||
run: | ||
working-directory: ./docs | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
- name: Setup Ruby | ||
uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: '3.3' | ||
bundler-cache: true | ||
cache-version: 0 | ||
working-directory: '${{ github.workspace }}/docs' | ||
- name: Build with Jekyll | ||
run: bundle exec jekyll 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,51 @@ | ||
name: Deploy Product Central Wiki to Pages | ||
|
||
on: | ||
push: | ||
branches: ["main"] | ||
paths: | ||
- "docs/**" | ||
|
||
permissions: | ||
contents: read | ||
pages: write | ||
id-token: write | ||
|
||
concurrency: | ||
group: "pages" | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
- name: Setup Ruby | ||
uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: '3.3' | ||
bundler-cache: true | ||
cache-version: 0 | ||
- name: Setup Pages | ||
id: pages | ||
uses: actions/configure-pages@v5 | ||
- name: Build with Jekyll | ||
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" | ||
env: | ||
JEKYLL_ENV: production | ||
- name: Upload artifact | ||
uses: actions/upload-pages-artifact@v3 | ||
with: | ||
path: "docs/_site/" | ||
|
||
deploy: | ||
environment: | ||
name: github-pages | ||
url: ${{ steps.deployment.outputs.page_url }} | ||
runs-on: ubuntu-latest | ||
needs: build | ||
steps: | ||
- name: Deploy to GitHub Pages | ||
id: deployment | ||
uses: actions/deploy-pages@v4 |
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,10 @@ | ||
.PHONY: install-docs serve-docs build-docs | ||
|
||
install-docs: | ||
cd docs && bundle install | ||
|
||
serve-docs: | ||
cd docs && bundle exec jekyll serve | ||
|
||
build-docs: | ||
cd docs && bundle exec jekyll 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 |
---|---|---|
@@ -1,3 +1,69 @@ | ||
# Software Architectures | ||
# Product Central Architecture | ||
|
||
Collection of Software Architectures / Golden Path for Product Central. | ||
Welcome to the Product Central Architecture repository. This space is designed to provide comprehensive guidance and resources for contributors and users of Product Central's reference architecture templates. | ||
|
||
## Overview | ||
|
||
Product Central provides a set of reference architecture templates to help developers and teams streamline the development and deployment of their applications. These templates offer best practices, standardized structures, and ready-to-use components, ensuring consistency and quality across projects. | ||
|
||
## Getting Started | ||
|
||
### Key Sections | ||
|
||
1. **Introduction**: Learn about Product Central, its mission, and the benefits of using reference architecture templates. | ||
2. **Contributing**: Detailed guidelines on how to contribute to the repository, including forking, cloning, creating content, and raising pull requests. | ||
3. **Templates**: Explore the various templates available, their use cases, and detailed documentation. | ||
4. **Documentation**: Access comprehensive documentation on each template, including TechDocs and Architectural Decision Records (ADRs). | ||
5. **Support**: Find resources for troubleshooting, support channels, and contact information for repository maintainers. | ||
|
||
## Introduction | ||
|
||
Product Central aims to standardize and simplify the development process by providing reference architecture templates that embody best practices and scalable solutions. These templates help teams accelerate their projects and ensure they are built on robust, well-defined foundations. | ||
|
||
### Reference Architecture | ||
|
||
Reference architecture serves as a blueprint for designing and implementing systems. It encapsulates best practices, guidelines, and standardized components to create a robust and scalable architecture. | ||
|
||
#### Benefits of Reference Architecture: | ||
|
||
- **Guidance**: Provides clear guidelines on the structure and components of the system. | ||
- **Reusability**: Components and patterns can be reused across different projects, saving time and effort. | ||
- **Quality**: Ensures that the system adheres to best practices and industry standards. | ||
|
||
### Benefits of Using Product Central Templates | ||
|
||
- **Consistency**: Maintain a consistent structure across projects. | ||
- **Best Practices**: Leverage industry best practices embedded in the templates. | ||
- **Time-Saving**: Reduce development time with ready-to-use components. | ||
- **Scalability**: Build scalable and maintainable applications. | ||
|
||
## Contributing | ||
|
||
Interested in contributing? Visit our [Contributing Guide](https://github.com/99x/product-central-architectures/wiki/Contributing-to-Product-Central-Reference-Architecture-Templates) to learn how you can add value to our repository. Whether you’re improving existing templates or creating new ones, your contributions are welcome and valued. | ||
|
||
## Templates | ||
|
||
Our repository includes a variety of templates tailored for different use cases. Each template is thoroughly documented to help you understand its purpose and how to integrate it into your projects. | ||
|
||
Explore our templates: | ||
|
||
- **[AWS Fullstack App](https://github.com/99x/product-central-architectures/tree/main/architectures/github/aws-fullstack-app)** | ||
- **[99x Design System](https://github.com/99x/product-central-architectures/tree/main/architectures/github/99x-design-system)** | ||
- **[Product Central on AWS](https://github.com/99x/product-central-architectures/tree/main/architectures/github/pdp-aws)** | ||
|
||
## Documentation | ||
|
||
Documentation is key to understanding and effectively using our templates. Each template comes with: | ||
|
||
- **TechDocs**: Detailed technical documentation explaining the template’s purpose, setup, and usage. | ||
- **ADRs**: Architectural Decision Records that capture the reasoning behind key technical decisions. | ||
|
||
## Support | ||
|
||
Need help? Reach out to the Product Central Team and we are happy to assist you! | ||
|
||
## Contact Us | ||
|
||
For any queries or further assistance, please reach out to the repository maintainers or join our community discussions on GitHub. | ||
|
||
Thank you for being a part of the Product Central community. Together, we can build better, faster, and more scalable solutions. |
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,7 @@ | ||
source 'https://rubygems.org' | ||
|
||
gem "jekyll", "~> 4.3.3" # installed by `gem jekyll` | ||
# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 | ||
|
||
gem "just-the-docs", "0.10.0" # pinned to the current release | ||
# gem "just-the-docs" # always download the latest release |
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,91 @@ | ||
GEM | ||
remote: https://rubygems.org/ | ||
specs: | ||
addressable (2.8.7) | ||
public_suffix (>= 2.0.2, < 7.0) | ||
bigdecimal (3.1.8) | ||
colorator (1.1.0) | ||
concurrent-ruby (1.3.4) | ||
em-websocket (0.5.3) | ||
eventmachine (>= 0.12.9) | ||
http_parser.rb (~> 0) | ||
eventmachine (1.2.7) | ||
ffi (1.17.0-arm64-darwin) | ||
ffi (1.17.0-x86_64-linux-gnu) | ||
forwardable-extended (2.6.0) | ||
google-protobuf (4.28.0-arm64-darwin) | ||
bigdecimal | ||
rake (>= 13) | ||
google-protobuf (4.28.0-x86_64-linux) | ||
bigdecimal | ||
rake (>= 13) | ||
http_parser.rb (0.8.0) | ||
i18n (1.14.5) | ||
concurrent-ruby (~> 1.0) | ||
jekyll (4.3.3) | ||
addressable (~> 2.4) | ||
colorator (~> 1.0) | ||
em-websocket (~> 0.5) | ||
i18n (~> 1.0) | ||
jekyll-sass-converter (>= 2.0, < 4.0) | ||
jekyll-watch (~> 2.0) | ||
kramdown (~> 2.3, >= 2.3.1) | ||
kramdown-parser-gfm (~> 1.0) | ||
liquid (~> 4.0) | ||
mercenary (>= 0.3.6, < 0.5) | ||
pathutil (~> 0.9) | ||
rouge (>= 3.0, < 5.0) | ||
safe_yaml (~> 1.0) | ||
terminal-table (>= 1.8, < 4.0) | ||
webrick (~> 1.7) | ||
jekyll-include-cache (0.2.1) | ||
jekyll (>= 3.7, < 5.0) | ||
jekyll-sass-converter (3.0.0) | ||
sass-embedded (~> 1.54) | ||
jekyll-seo-tag (2.8.0) | ||
jekyll (>= 3.8, < 5.0) | ||
jekyll-watch (2.2.1) | ||
listen (~> 3.0) | ||
just-the-docs (0.10.0) | ||
jekyll (>= 3.8.5) | ||
jekyll-include-cache | ||
jekyll-seo-tag (>= 2.0) | ||
rake (>= 12.3.1) | ||
kramdown (2.4.0) | ||
rexml | ||
kramdown-parser-gfm (1.1.0) | ||
kramdown (~> 2.0) | ||
liquid (4.0.4) | ||
listen (3.9.0) | ||
rb-fsevent (~> 0.10, >= 0.10.3) | ||
rb-inotify (~> 0.9, >= 0.9.10) | ||
mercenary (0.4.0) | ||
pathutil (0.16.2) | ||
forwardable-extended (~> 2.6) | ||
public_suffix (6.0.1) | ||
rake (13.2.1) | ||
rb-fsevent (0.11.2) | ||
rb-inotify (0.11.1) | ||
ffi (~> 1.0) | ||
rexml (3.3.7) | ||
rouge (4.3.0) | ||
safe_yaml (1.0.5) | ||
sass-embedded (1.78.0-arm64-darwin) | ||
google-protobuf (~> 4.27) | ||
sass-embedded (1.78.0-x86_64-linux-gnu) | ||
google-protobuf (~> 4.27) | ||
terminal-table (3.0.2) | ||
unicode-display_width (>= 1.1.1, < 3) | ||
unicode-display_width (2.5.0) | ||
webrick (1.8.1) | ||
|
||
PLATFORMS | ||
arm64-darwin | ||
x86_64-linux-gnu | ||
|
||
DEPENDENCIES | ||
jekyll (~> 4.3.3) | ||
just-the-docs (= 0.10.0) | ||
|
||
BUNDLED WITH | ||
2.5.9 |
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,33 @@ | ||
title: Product Central Architectures | ||
description: Collection of Software Architectures / Golden Path for Product Central buckets bundled with TechDocs and ADR. | ||
theme: just-the-docs | ||
|
||
logo: /assets/img/product-central-logo-light.svg | ||
favicon_ico: /assets/img/product-central-icon-light.svg | ||
|
||
url: https://99x.github.io/product-central-architectures | ||
|
||
aux_links: | ||
Template Repository: https://github.com/99x/product-central-architectures | ||
|
||
search_enabled: true | ||
|
||
search: | ||
heading_level: 2 | ||
previews: 3 | ||
preview_words_before: 5 | ||
preview_words_after: 10 | ||
tokenizer_separator: /[\s/]+/ | ||
rel_url: true | ||
button: false | ||
focus_shortcut_key: 'k' | ||
|
||
mermaid: | ||
version: "9.1.3" | ||
|
||
nav_enabled: true | ||
|
||
heading_anchors: true | ||
|
||
color_scheme: light | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.