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

Docs Full IA Update #1639

Merged
merged 9 commits into from
May 2, 2023
Merged

Docs Full IA Update #1639

merged 9 commits into from
May 2, 2023

Conversation

Jessy-Morris
Copy link
Contributor

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

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

@Jessy-Morris Jessy-Morris added the documentation 📘 Improvements or additions to documentation label Apr 21, 2023
@Jessy-Morris Jessy-Morris linked an issue Apr 21, 2023 that may be closed by this pull request
4 tasks
@Jessy-Morris Jessy-Morris requested review from YrrepNoj, Racer159, wirewc and a team as code owners April 21, 2023 17:21
@netlify
Copy link

netlify bot commented Apr 21, 2023

Deploy Preview for zarf-docs ready!

Name Link
🔨 Latest commit 7d33249
🔍 Latest deploy log https://app.netlify.com/sites/zarf-docs/deploys/645150b2d1bca700081d4ad9
😎 Deploy Preview https://deploy-preview-1639--zarf-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@Jessy-Morris Jessy-Morris requested a review from Noxsios as a code owner April 26, 2023 18:27
Copy link
Contributor

@Noxsios Noxsios left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some changes, mainly w/ link naming consistency

README.md Outdated Show resolved Hide resolved
docs/13-walkthroughs/1-initializing-a-k8s-cluster.md Outdated Show resolved Hide resolved
docs/13-walkthroughs/2-deploying-zarf-packages.md Outdated Show resolved Hide resolved
docs/13-walkthroughs/3-deploy-a-retro-arcade.md Outdated Show resolved Hide resolved
docs/13-walkthroughs/5-creating-a-k8s-cluster-with-zarf.md Outdated Show resolved Hide resolved
docs/4-user-guide/index.md Outdated Show resolved Hide resolved
docs/7-dashboard-ui/3-Zarf-deployment-ui.md Outdated Show resolved Hide resolved
docs/7-dashboard-ui/3-Zarf-deployment-ui.md Outdated Show resolved Hide resolved
docs/7-dashboard-ui/3-Zarf-deployment-ui.md Outdated Show resolved Hide resolved
docs/13-walkthroughs/0-using-zarf-package-create.md Outdated Show resolved Hide resolved
## 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 <[email protected]>
@Racer159 Racer159 requested a review from mike-winberry as a code owner May 1, 2023 19:38
@Racer159 Racer159 changed the title Docs IA Update "Getting Started" Docs Full IA Update May 1, 2023
Copy link
Contributor

@Noxsios Noxsios left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lg overall to me

@Racer159 Racer159 merged commit 8653011 into main May 2, 2023
@Racer159 Racer159 deleted the 1628-docs-ia-update branch May 2, 2023 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📘 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs IA update
3 participants