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.

Sign up for GitHub

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

Jump to bottom

Come up with a good Information Architecture for Documentation Site #460

Closed
cmwylie19 opened this issue Jan 8, 2024 · 1 comment · Fixed by #496
Closed

Come up with a good Information Architecture for Documentation Site #460

cmwylie19 opened this issue Jan 8, 2024 · 1 comment · Fixed by #496
Assignees
@schaeferka
Labels
documentation Improvements or additions to documentation tech-debt

Comments

@cmwylie19
Copy link
Collaborator

cmwylie19 commented Jan 8, 2024 •
edited

Describe what should be investigated or refactored

Be intentional the structure of our docs and titles. Currently there is no uniformity and we want to improve our documentation site. Rework the content of the docs folder so that the docs site looks correct.

Outline the structure of what the folders and subfolder structure should look like.

Plan out subsections.

Links to any relevant code

The first H1 in the markdown file is what id displayed in the links as the title for the documentation

Additional context

Add any other context or screenshots about the technical debt here.
@cmwylie19 cmwylie19 changed the title Come up with a good Information Architecture Come up with a good Information Architecture for Documentation Site Jan 8, 2024
@cmwylie19 cmwylie19 added the documentation Improvements or additions to documentation label Jan 8, 2024
@schaeferka schaeferka self-assigned this Jan 10, 2024
@cmwylie19
Copy link
Collaborator Author

cmwylie19 commented Jan 12, 2024 •
edited

Next Steps For docs :

  • Kim and Barrett sync on the workflow (local flow)
  • Agree on Information Architecture Template (Structural)
  • Google Docs Working Doc to keep track of needed docs (Assign sections to become issues) (The content)

@schaeferka schaeferka mentioned this issue Jan 18, 2024
Merged
5 tasks
@schaeferka schaeferka linked a pull request Jan 18, 2024 that will close this issue
feat: docs information architecture #496
Merged
5 tasks
btlghrants pushed a commit that referenced this issue Jan 22, 2024
@schaeferka @cmwylie19
feat: docs information architecture (#496)
58f79c3 
## Description

Updating content and information architecture of the docs.

## Related Issue

Fixes #
<!-- or -->
Relates to #460 

## Type of change

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

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor Guide
Steps](https://github.com/defenseunicorns/pepr/blob/main/CONTRIBUTING.md#submitting-a-pull-request)
followed

---------

Co-authored-by: Case Wylie <cmwylie19@defenseunicorns.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@schaeferka schaeferka

Labels
documentation Improvements or additions to documentation tech-debt
Projects
Pepr Project Board
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: docs information architecture defenseunicorns/pepr
2 participants
@cmwylie19 @schaeferka