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

Re-org of volumes content #1062

Merged
merged 13 commits into from
Sep 27, 2023
Merged

Re-org of volumes content #1062

merged 13 commits into from
Sep 27, 2023

Conversation

andie787
Copy link
Contributor

@andie787 andie787 commented Sep 22, 2023

The larger aim here is:

  • Task-based content with no extra stuff in in (How-Tos)
  • Conceptual info all in one place (Overview/Learn)
  • Links to "related topics" at the bottom of pages
  • (What we're missing is tutorials)

Summary of changes

  • New docs:
    • Manage volumes (contains re-worked content with numbered steps from the Working with volumes section of the Volumes reference)
    • Volumes landing page (a note about design: i think landing pages should have "cards" for each type of doc)
  • Renamed Volumes reference to How Fly Volumes work Fly Volumes overview (per feedback)
  • Add volume storage: Removed extra info from to make it more quick/procedural, moved that extra content into Fly Volumes overview, added numbered steps to remaining content
  • Added a Related topics list of links to the bottom of each page to link them all together
  • Nav: Add volumes and Manage volumes are under launch, Fly Volumes overview is under reference. We had two links to Volumes reference: one under reference and one under Databases and Storage; this PR changes the link under Databases and Storage to the new Volumes landing page.

Questions:
We're going to need to mix "launch" and "machine" features because where launch features end, launch users need to use flyctl commands etc. How do we fit that in the nav since we renamed Fly Apps to Fly Launch? This is a problem to solve.

Preview links (updated)

Volumes landing page: https://aa-docs-2.fly.dev/docs/volumes/ (links to all pages)
How Volumes work Fly Volumes overview: https://aa-docs-2.fly.dev/docs/reference/volumes/
Add volume storage: https://aa-docs-2.fly.dev/docs/apps/volume-storage/
Manage volume storage: https://aa-docs-2.fly.dev/docs/apps/volume-manage/

Related GitHub and Fly.io community links

first version (very similar): #939

Notes

  • sometimes when users found the volume reference page they missed the Add volume storage page entirely and then didn't know about fly.toml

@andie787 andie787 marked this pull request as ready for review September 22, 2023 20:30
partials/_firecracker_nav.html.erb Show resolved Hide resolved
partials/_volumes_nav.html.erb Outdated Show resolved Hide resolved
@andie787 andie787 merged commit 97a48ad into main Sep 27, 2023
3 checks passed
@andie787 andie787 deleted the new-volumes branch October 25, 2023 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants