UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects
Commit 71ec0916 authored by Michael McLeroy's avatar Michael McLeroy
Browse files

Merge branch 'BBOI-382_charter_doc_strategy' into 'master'

Charter, Documentation Locations

See merge request platform-one/big-bang/bigbang!277
parents 9fd669c5 305ff9c2
No related branches found
No related tags found
1 merge request!277Charter, Documentation Locations
# Note: This charter doc represents the future state we are working toward
# BigBang Docs:
## Where is the best place to look for documentation on BigBang?
- https://repo1.dso.mil/platform-one/big-bang/bigbang/-/tree/master/docs/
- Our goal is to have near 100% of publicly sharable docs in this centralized location to act as a single source of truth where all documentation can be found and help move docs out of IL2 Confluence and Private Repos to better support the open source community.
## What types of documentation can be found in the docs folder?
- Developer Contribution Docs
- Docs to help understand BigBang (At a concrete level, what the value add is, and Architecture Diagrams)
- Deployment Prerequisites
- Deployment Docs for Internet Connected and Disconnected deployments
# BigBang Package Docs:
## Where is the best place to look for documentation on BigBang Packages?
- Our goal is to have these docs available on a webpage hosted on the BigBang Cluster using Hugo
(https://docs.bigbang.dev by default) (look [here](https://repo1.dso.mil/platform-one/big-bang/bigbang/-/blob/master/charter/PackageDocumentation.md) for more info)
- This allows us to support a centralized location for package configuration documentation, while allowing support for dynamically added versions of distributed packages in a maintainable way.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment