open-guides / og-aws

📙 Amazon Web Services — a practical guide
Creative Commons Attribution 4.0 International
35.65k stars 3.87k forks source link

Alphabetise top list #619

Closed M1ke closed 5 years ago

M1ke commented 6 years ago

Easier to read the top list and find a specific service

QuinnyPig commented 6 years ago

I like this a lot, but it does change the structure of the guide somewhat. Would appreciate others' feedback prior to merge.

M1ke commented 6 years ago

Just to add some more explanation, here's how I explained this to Corey on Slack:

[CQ] That’d be incredibly handy - but does alphabetically make more sense than by service area?

I think in that list it does - the service areas aren't wholly defined (i.e. the guide definitions are different from AWSs own definitions) and they're not clear in that list anyway.

So if I am looking for one service I'd need to scroll down to the category bit, then back up to that list

salexpdx commented 6 years ago

This seems like one of those changes that is so obvious after the fact, but something that people who are used to the project wouldn't think of. I think it will make it easier for new people to find the section they want since they won't have to use find in document and can just scroll the list in order.

As for service area vs alpha I think that adding more consistency might help with that. Right now there is CLB, ALB, and Load Balancers as topics. If they were all EC2 Load Balancers - Elastic [ELB], etc that would keep the three together, and make the alpha order very easy.

M1ke commented 6 years ago

@QuinnyPig @salexpdx I'm happy to do that change too if it will help. I'd suggest the same with Glacier; you can't use Glacier without s3, there's no separate interface for it, so S3 - Glacier would make more sense in the ordering, other than that some people might have heard of Glacier as a brand.

I also wonder if SES, SQS & SNS are well enough known acronyms and could be improved by noting the name - then someone who's starting to read with the question "does AWS have a message queue" gets their question answered reading the index. I believe S3 and EC2 are big enough brand names they don't need to be explained in the same way.

M1ke commented 6 years ago

@QuinnyPig what do you think to my suggestions above?

M1ke commented 6 years ago

@QuinnyPig @salexpdx any update on this? The Travis build failed but looks like it's due to something unrelated, a URL check that failed but I've not modified any URLs

QuinnyPig commented 6 years ago

Yeah, ignore the Travis results. I think you two are correct; if you get this to merge cleanly I'll endorse it!

M1ke commented 6 years ago

@QuinnyPig Have now resolved the conflict so we can merge this

QuinnyPig commented 5 years ago

It would seem not. One more conflict resolve, and I'll merge it!

M1ke commented 5 years ago

Ok I'll check it tomorrow, it was merging cleanly when I last commented but guess other stuff has changed

On Thu, 4 Oct 2018, 8:54 pm Corey Quinn, notifications@github.com wrote:

It would seem not. One more conflict resolve, and I'll merge it!

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/open-guides/og-aws/pull/619#issuecomment-427147906, or mute the thread https://github.com/notifications/unsubscribe-auth/ABK1iz9X8U635mbXPX-Q4EEb-yNhE-jQks5uhmdngaJpZM4Vc4le .

maishsk commented 5 years ago

@M1ke we still have some conflicts - can you have a look please?

M1ke commented 5 years ago

@maishsk @QuinnyPig have just merged in latest master and resolved conflicts, should be all good!

QuinnyPig commented 5 years ago

Glorious! Merging.

maishsk commented 5 years ago

LGTM