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

Docs IA update #1628

Closed
4 tasks done
Madeline-UX opened this issue Apr 19, 2023 · 0 comments · Fixed by #1639
Closed
4 tasks done

Docs IA update #1628

Madeline-UX opened this issue Apr 19, 2023 · 0 comments · Fixed by #1639
Assignees
@Jessy-Morris
Labels
documentation 📘 Improvements or additions to documentation ux

Comments

@Madeline-UX
Copy link
Contributor

Madeline-UX commented Apr 19, 2023 •
edited by Jessy-Morris
Loading

Based on user feedback and to improve the information architecture, we are creating a "Getting Started" folder. All links associated with the changed files have been modified accordingly.

  • Remove operator manual
  • Create "Getting Started" file
  • Move Understand the Basics, Core Concepts, and Getting Started into one folder
  • Fix any broken links that to pointed set up and install

Relates to #1397

PUBLIC - Zarf Project - New Docs Information Architecture.pdf
@Madeline-UX Madeline-UX added documentation 📘 Improvements or additions to documentation ux labels Apr 19, 2023
@Jessy-Morris Jessy-Morris self-assigned this Apr 21, 2023
@Jessy-Morris Jessy-Morris mentioned this issue Apr 21, 2023
Merged
5 tasks
@Jessy-Morris Jessy-Morris linked a pull request Apr 21, 2023 that will close this issue
Docs Full IA Update #1639
Merged
5 tasks
@Racer159 Racer159 mentioned this issue May 1, 2023
Merged
5 tasks
Racer159 added a commit that referenced this issue May 1, 2023
@Racer159 @Noxsios
Update the docs to match the new Information Architecture (#1663)
4eaec74 
## Description

This is a pretty big restructuring/rewrite of our docs per the IA
updates suggested by @Jessy-Morris and @Madeline-UX

## Related Issue

Fixes #1628 

## 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/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

---------

Co-authored-by: razzle <harry@razzle.cloud>
Racer159 added a commit that referenced this issue May 2, 2023
@Jessy-Morris @Racer159 @Noxsios
Docs Full IA Update (#1639)
8653011 
Based on user feedback and to improve the information architecture, we
are creating a "Getting Started" folder. All links associated with the
changed files have been modified accordingly.

-  Remove operator manual
-  Create "Getting Started" file
- Move Understand the Basics, Core Concepts, and Getting Started into
one folder
-  Fix any broken links that to pointed set up and install


## Related Issue

Fixes #1628 
Relates to #1397 

[PUBLIC - Zarf Project - New Docs Information
Architecture.pdf](https://github.com/defenseunicorns/zarf/files/11297954/PUBLIC.-.Zarf.Project.-.New.Docs.Information.Architecture.pdf)

## 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/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

---------

Co-authored-by: Wayne Starr <me@racer159.com>
Co-authored-by: Wayne Starr <Racer159@users.noreply.github.com>
Co-authored-by: razzle <harry@razzle.cloud>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Jessy-Morris Jessy-Morris

Labels
documentation 📘 Improvements or additions to documentation ux
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs Full IA Update zarf-dev/zarf
2 participants
@Madeline-UX @Jessy-Morris