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

Port over existing docs into Hugo Site #332

Closed
cmwylie19 opened this issue Oct 22, 2023 · 0 comments · Fixed by #334
Closed

Port over existing docs into Hugo Site #332

cmwylie19 opened this issue Oct 22, 2023 · 0 comments · Fixed by #334
Assignees
@cmwylie19
Labels
tech-debt

Comments

@cmwylie19
Copy link
Collaborator

Describe what should be investigated or refactored

We have existing documents in the docs directory and many issues around docs. In order to be prepared to address the docs issues we must first port our existing docs over to the site.

Links to any relevant code

docs
website

Additional context

Add any other context or screenshots about the technical debt here.
@cmwylie19 cmwylie19 self-assigned this Oct 22, 2023
@cmwylie19 cmwylie19 moved this from 🆕 New to 🏗 In progress in Pepr Project Board Oct 22, 2023
@cmwylie19 cmwylie19 mentioned this issue Oct 22, 2023
Merged
5 tasks
cmwylie19 added a commit that referenced this issue Oct 23, 2023
@cmwylie19
docs: port over existing docs to hugo site (#334)
286e468 
## Description

Port over existing repo docs to the Hugo site.

AC: Ensure that all content is accurately and completely transferred,
maintaining its original meaning and structure. The documentation should
be consistently formatted, adhering to the Hugo site’s style guidelines,
with all links, images, and code snippets functioning correctly.
Additionally, the documentation must be easily navigable, responsive
across various devices, and fully compatible with different browsers,
ensuring a seamless user experience.

Will need to update
[`README.md`](https://github.com/defenseunicorns/pepr/blob/b6aadddc570fb5ac63e3c98a72eb81b0bf98b078/README.md?plain=1#L3)
when site goes live


## Related Issue

Fixes #332 
<!-- or -->
Relates to #324 (If any docs change, they need to change here)

## 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

---------

Signed-off-by: Case Wylie <[email protected]>
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Pepr Project Board Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cmwylie19 cmwylie19

Labels
tech-debt
Projects
Pepr Project Board
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: port over existing docs to hugo site defenseunicorns/pepr
1 participant
@cmwylie19