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

chore(docs): re-organize docs for docs website consumption #495

Merged
merged 6 commits into from
Jun 27, 2024

Conversation

brandtkeller
Copy link
Member

Description

Attempt to set new docs organization for the lula-docs website.

Related Issue

Fixes #490

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

Signed-off-by: Brandt Keller <brandt.keller@defenseunicorns.com>
Copy link

netlify bot commented Jun 20, 2024

Deploy Preview for lula-docs canceled.

Name Link
🔨 Latest commit 75a5310
🔍 Latest deploy log https://app.netlify.com/sites/lula-docs/deploys/667dcd6241ce650008c88494

@meganwolf0
Copy link
Collaborator

Is there a good example to look at for how the file/folder structure maps to the website UI?

@bdfinst
Copy link
Contributor

bdfinst commented Jun 20, 2024

Is there a good example to look at for how the file/folder structure maps to the website UI?

You can see an example here:
https://github.com/defenseunicorns/uds/tree/main/content/en

@meganwolf0
Copy link
Collaborator

I think this looks good, I have a few thoughts, but I know we don't really have the documentation to support yet so really just jotting down notes somewhere for discussion

  • I think we need like a "what is lula/about" section that details more of the use cases and how to use Lula, perhaps a subsection we'd have "building a validation" or something similar. I'm thinking this could link to the other docs in oscal and references
  • I think we probably need some more detailed information for the lula validation yaml, which could be an autodoc generated from the schema
  • Wondering if we should repurpose the evaluate into like a quickstart with details on the validate command as well.

@brandtkeller
Copy link
Member Author

I think this looks good, I have a few thoughts, but I know we don't really have the documentation to support yet so really just jotting down notes somewhere for discussion

  • I think we need like a "what is lula/about" section that details more of the use cases and how to use Lula, perhaps a subsection we'd have "building a validation" or something similar. I'm thinking this could link to the other docs in oscal and references
  • I think we probably need some more detailed information for the lula validation yaml, which could be an autodoc generated from the schema
  • Wondering if we should repurpose the evaluate into like a quickstart with details on the validate command as well.

I completely agree - I believe we have more than a few efforts for documentation to support going forward. Let's get some structure in-place such that we can wire docs up to the website and iterate.

@brandtkeller brandtkeller marked this pull request as draft June 21, 2024 13:42
@brandtkeller brandtkeller marked this pull request as ready for review June 25, 2024 04:13
@brandtkeller brandtkeller merged commit 24c24f0 into main Jun 27, 2024
6 checks passed
@brandtkeller brandtkeller deleted the 490_docs_organization branch June 27, 2024 21:08
This was referenced Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Docs organization and headings
4 participants