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

Update Pepr docs #802

Closed
schaeferka opened this issue May 15, 2024 · 0 comments · Fixed by #804
Closed

Update Pepr docs #802

schaeferka opened this issue May 15, 2024 · 0 comments · Fixed by #804
Assignees
@schaeferka
Labels
tech-debt

Comments

@schaeferka
Copy link
Collaborator

Describe what should be investigated or refactored

With the root level markdown files now being pulled directly into the Pepr docs website, we need to review/update the markdown files in the Pepr Core docs folder to remove duplicate content, update links, and revise as needed for consistent style.

Links to any relevant code

(optional) i.e. -

pepr/README.md

Line 3 in 24f1f25

[![Pepr Documentation](https://img.shields.io/badge/docs--d25ba1)](./docs/README.md)

Additional context

Add any other context or screenshots about the technical debt here.
@schaeferka schaeferka self-assigned this May 15, 2024
@schaeferka schaeferka mentioned this issue May 16, 2024
Merged
5 tasks
@schaeferka schaeferka linked a pull request May 16, 2024 that will close this issue
chore: updates to markdown files to match updated pepr-docs structure #804
Merged
5 tasks
cmwylie19 pushed a commit that referenced this issue May 17, 2024
@schaeferka
chore: updates to markdown files to match updated pepr-docs structure (…
73507d6 
…#804)

## Description

With the root level markdown files now being pulled directly into the
Pepr docs website, we need to review/update the markdown files in the
Pepr Core docs folder to remove duplicate content, update links, and
revise as needed for consistent style.
...

## Related Issue

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

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

- [ ] Test, docs, adr added or updated as needed
- [ ] [Contributor Guide
Steps](https://docs.pepr.dev/main/contribute/contributor-guide/#submitting-a-pull-request)
followed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@schaeferka schaeferka

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

Successfully merging a pull request may close this issue.

chore: updates to markdown files to match updated pepr-docs structure defenseunicorns/pepr
1 participant
@schaeferka