feat: Add architecture documentation in architecture tab and ADRs#271
Draft
feat: Add architecture documentation in architecture tab and ADRs#271
architecture tab and ADRs#271Conversation
- Introduced a new sidebar for architecture documentation in docusaurus.config.ts. - Created initial ADRs for monorepo decision and versioning strategy. - Added category files for architecture and ADRs. - Implemented scripts for generating ADR PDFs and updating ADR index. - Updated package.json to include new scripts for ADR management. - Added placeholder certification documentation with a "Coming Soon" message. - Created versioned documentation for architecture across multiple versions.
matbmoser
changed the title
architecture tab and ADRs
Member
Author
|
I made an initial work, which is not 100% ready, I need to remove some files before we publish, and make a bit more beautiful. |
Member
|
@matbmoser , please talk to @jSchuetz88 and myself before further working on this PR ... we want to reduce complexity on this static webpage and we already have some sync mechanism for standards, operating model and working model. Thx |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Architecture Committee Task for publishing ADRs in the website
WHAT
WHY
The architecture committe wants to publish their ADRs in the website.
PENDING WORK
Automatizate the publication of the ADRs which are located at the cx-architecture repo -> catena-x.github.io
Closes #https://github.com/catenax-eV/cx-architecture/issues/57