Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: restructure to trg1 and add policies and attributes #214

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Phil91
Copy link
Member

@Phil91 Phil91 commented Oct 7, 2024

Description

  • adjust documentation structure to align with TRG1
  • add documentation to add policies and policy attributes

Why

To align with trg 1 and give the overview of how to add new policies and policy attributes.

Issue

Refs: #178 #197

Checklist

  • I have followed the contributing guidelines
  • I have performed a self-review of my own code
  • I have successfully tested my changes locally
  • I have added tests that prove my changes work
  • I have checked that new and existing tests pass locally with my changes
  • I have commented my code, particularly in hard-to-understand areas
  • I have added copyright and license headers, footers (for .md files) or files (for images)

@Phil91 Phil91 added this to the Release 24.12 milestone Oct 7, 2024
@Phil91 Phil91 force-pushed the docs/178-attribute branch 2 times, most recently from 608c3d9 to 364d336 Compare October 7, 2024 11:00
@evegufy evegufy changed the title docs: add documentation to add policies and attributes docs: restructure to trg1 and add policies and attributes Oct 24, 2024
Copy link
Contributor

@evegufy evegufy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add /docs/README.md and align with eclipse-tractusx/ssi-authority-schema-registry#71 where it makes sense

@Phil91
Copy link
Member Author

Phil91 commented Oct 24, 2024

@Phil91 Phil91 requested a review from evegufy October 24, 2024 07:15
docs/architecture/Index.md Outdated Show resolved Hide resolved
docs/architecture/Index.md Outdated Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can be removed due to #186 (comment)
for future reference, I'd put it under docs/admin

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adjusted

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

might make sense to rename docs/admin/add-policies/add-policies.md

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adjusted

* adjust documentation structure to align with TRG1
* add documentation to add policies and policy attributes

Refs: #178 #197
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: IN PROGRESS
Development

Successfully merging this pull request may close these issues.

2 participants