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

[Question] Namespace level in docs #579

Closed
meganwolf0 opened this issue Aug 6, 2024 · 2 comments · Fixed by #602
Closed

[Question] Namespace level in docs #579

meganwolf0 opened this issue Aug 6, 2024 · 2 comments · Fixed by #602
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@meganwolf0
Copy link
Collaborator

meganwolf0 commented Aug 6, 2024

Not so much a feature request as a question/nit on the docs - The namespace docs appear at the top-level menu in the Lula docs, wondering if this would make more sense as a subset of OSCAL, since that's the context in which namespace is defined?

Just wanted to raise it as a question/possible move, it feels a little out of place to me right now

Proposed Solution

Move namespace directory under OSCAL

Expected Deliverable

Add a constant for the props namespace value

Updating props internal to validate/evaluate to point to the new namespace url

generate updates to update a prop ns from the old url to the new

@meganwolf0 meganwolf0 added the question Further information is requested label Aug 6, 2024
@github-actions github-actions bot added the triage Awaiting triage from the team label Aug 6, 2024
@brandtkeller
Copy link
Member

I agree that it intuitively should live underneath the oscal directory.

The only drawback is that we'll need to consider our current props use (threshold, framework, target etc) that current resolve to https://docs.lula.dev/ns and either update as a breaking change or provide backwards compatibility under-the-hood.

@meganwolf0
Copy link
Collaborator Author

The only drawback is that we'll need to consider our current props use (threshold, framework, target etc) that current resolve to https://docs.lula.dev/ns and either update as a breaking change or provide backwards compatibility under-the-hood.

Yeah that's a fair point. I think probably just an update with a note would suffice? Does a broken link break any kind of oscal linting?

@brandtkeller brandtkeller added documentation Improvements or additions to documentation enhancement New feature or request and removed question Further information is requested triage Awaiting triage from the team labels Aug 12, 2024
@meganwolf0 meganwolf0 self-assigned this Aug 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants