cagov / odi-engineering

California Office of Digital Innovation engineering documentation
MIT License
2 stars 0 forks source link

AWS Certificate documentation for our PR preview documentation #86

Closed chachasikes closed 2 years ago

chachasikes commented 2 years ago

Our wiki page for PR previews mentions "managing AWS certificates"

We are getting the PR preview set up for upcoming cannabis headless work https://github.com/cagov/Help-Desk/issues/652

Aaron needed to do this step, as according this this documentation (which is very good - seems like it's just a few notes on the final part of the process that aren't entirely self-service.)

https://github.com/cagov/odi-engineering/wiki/Set-up-PR-preview-sites

I'm attaching a screenshot Screen Shot 2022-08-12 at 2 30 03 PM

Seems like AWS has a documentation labyrinth - or I'm missing some permissions. https://us-east-1.console.aws.amazon.com/acm/home?region=us-east-1#/welcome

I wouldn't have been able to complete this & would need to spend a lot of time with the documentation - or call for support.

Note: This is super common with AWS documentation. They often have one route that's documented & a legacy app pointing somewhere else - so it's hard to learn unless you have corporate support. Usually there is a training that happens - and then the person who attended the training will give live demos to team mates. (I think it was Chad who mentioned he had this training in the past.)

For working with AWS documentation (and most other corporate created documentation) - it's can be helpful to:

xjensen commented 2 years ago

Regarding the screenshot, is that all you see? The page looks scrolled down.

This is what I get.

Screen Shot 2022-08-12 at 15 40 54
chachasikes commented 2 years ago

Thanks Jon! That's helpful - I see the menu hamburger today (which I did not see on Friday)

It's very subtle & is also different from how AWS has done menus that I have used in the past.

Suggestions for docs:

Attaching more screenshots of how it looks when the menu is expanded.

Screen Shot 2022-08-15 at 9 26 34 AM

Screen Shot 2022-08-15 at 9 26 39 AM

zakiya commented 2 years ago

@chachasikes My two cents is that you should just go ahead and update the docs with your improvements.

chachasikes commented 2 years ago

Thx for the prompt to close this out.

Done: https://github.com/cagov/odi-engineering/wiki/Set-up-PR-preview-sites

I think the mini screenshots are sufficient for this.

Closing.