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

README revamp #98

Merged
merged 1 commit into from
Oct 19, 2021
Merged

README revamp #98

merged 1 commit into from
Oct 19, 2021

Conversation

btlghrants
Copy link
Contributor

@btlghrants btlghrants commented Oct 7, 2021

Not done or anything, but I've got (what I think is) a not-so-clunky layout (mostly) in-place for the top-level README.

I expect to continue working my way down the page & moving content over to subREADMEs as it makes sense. Just wanted to get something up for others to peep to make sure I wasn't taking us off in a direction we didn't want to go.

#47

@RothAndrew
Copy link
Member

I love your writing style bud! Super easy to read.

@btlghrants
Copy link
Contributor Author

Iron Bank login material moved over to it's own page. Moving on to the "Workstation Setup" page now.

@btlghrants
Copy link
Contributor Author

btlghrants commented Oct 12, 2021

Added "Workstation Setup" page, "Build Your First Zarf" page (to cover how to build & login to Iron Bank for the very first time), and "Supported OSes" pages.

I'm mostly done with the initial content refactor... just gotta figure out where the asciicinema-s should live now (and redo them to match the newest version of Zarf). Gonna pick this up again tomorrow, but hope to be able to merge for-reals in the next couple of days.

Any of the new content stuff (all roughed in with "TODO" links) I'll work on after that... prolly as part of a new PR.

@jeff-mccoy
Copy link
Member

If you have time I’d love to include asciicinemas for the examples too

@RothAndrew
Copy link
Member

I'd love to see this merged tomorrow, once @jeff-mccoy is back in the office. Can we all get together and look over it and get it in? We can always keep adding to it in new PRs.

@RothAndrew RothAndrew linked an issue Oct 19, 2021 that may be closed by this pull request
@RothAndrew RothAndrew removed a link to an issue Oct 19, 2021
@btlghrants btlghrants force-pushed the docs/47-update-readme branch 2 times, most recently from eb8f8b1 to 6861c9b Compare October 19, 2021 19:55
@btlghrants btlghrants marked this pull request as ready for review October 19, 2021 19:56
@btlghrants
Copy link
Contributor Author

btlghrants commented Oct 19, 2021

@RothAndrew I literally only changed markdown... do we really need to e2e this? I mean, no real rush or anything but doesn't seem like it'll do much but burn some processor time.

@RothAndrew
Copy link
Member

Not really, but it's a requirement for the branch protection rule so we should do it anyway

@btlghrants
Copy link
Contributor Author

btlghrants commented Oct 19, 2021

Squashed all the crazy WIPs & such. Should be ready whenever. Gonna leave this one tied to #47 & move over to another PR for the get started / game example README stuff.

@btlghrants btlghrants mentioned this pull request Oct 19, 2021
@RothAndrew
Copy link
Member

/test all

@RothAndrew RothAndrew self-requested a review October 19, 2021 23:21
@RothAndrew RothAndrew enabled auto-merge (squash) October 19, 2021 23:22
@RothAndrew
Copy link
Member

Guh. The commit wasn't signed. @btlghrants can you turn on signing and force push a signed commit?

@RothAndrew
Copy link
Member

Nevermind actually. I'm gonna use admin privs to merge anyway, but do a squash so it results in a signed commit on master. I've looked through all the changes and it all looks good.

@RothAndrew RothAndrew merged commit 3979fdc into master Oct 19, 2021
@RothAndrew RothAndrew deleted the docs/47-update-readme branch October 19, 2021 23:45
jeff-mccoy pushed a commit that referenced this pull request Feb 8, 2022
Signed-off-by: Jeff McCoy <code@jeffm.us>
Noxsios pushed a commit that referenced this pull request Mar 8, 2023
Signed-off-by: Jeff McCoy <code@jeffm.us>
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.

None yet

3 participants