Clean up and expand on EC2 tutorial #527

Open
gtaylor opened this Issue Jan 26, 2012 · 6 comments

Comments

Projects
None yet
2 participants
Contributor

gtaylor commented Jan 26, 2012

The EC2 tutorial could use some love. We'll flesh this issue out as people pitch in their input.

Contributor

gtaylor commented Jan 26, 2012

@rdodev is doing some work on this. If you're going to help, make sure to get in touch with him.

Contributor

rdodev commented Jan 26, 2012

@gtaylor Yup yup. I have on my to-do list.

Contributor

rdodev commented Jan 27, 2012

@gtaylor Here are my suggested changes for EC2 tut

Spin off regions to their own tut. I would think most AWS users are familiar with the concept of region, so I'm thinking that whole section is a bit much.

Then split the tutorial in 3 parts.
Part I will focus on AMIs and EBS Volumes/Snapshots
Part II will focus on Instances (types, IPs, DNS and all that)
Part III will focus on Security groups, Elastic IPs, and so forth

If this sounds reasonable and agreeable, let me know.

Contributor

rdodev commented Jan 27, 2012

Alright, as per our conversation, I'll re-arrange it so that people can get up and running fast at first and then explaining EC2 platitudes later.

Contributor

gtaylor commented Feb 1, 2012

Lots of progress on this. We'll definitely need to prioritize the cleanup and working in of security groups. I think the best approach is to litter the relevant sections in the EC2 tutorial with :doc: references to the new security_groups doc I created from the old security groups section.

We can also create a "Managing security groups" section in the EC2 tut, provide a brief explanation of what security groups are and why they're important, then link to the security groups doc. This will keep the EC2 tutorial from getting too overwhelming.

Ditto for EBS and IPs and whatnot. Those are advanced topics that take up a lot of reading space. They should probably get a section in the tail end of the EC2 tutorial that just provides a brief overview, then links to the full write-up in a separate doc.

Does that sound reasonable? Django is taking a similar approach with some of their more advanced topics.

Contributor

rdodev commented Feb 1, 2012

I'm all for spinning off advanced and involved topics to their own documentation and reference it from within tutorials. And django tutorials was very much what I had in mind (except theirs, much like boto's, still need work to get to that sweet spot of simpleness and insightfulness, IMO). I've been busy at work, but will keep gnawing at it as I get time.

@dyzsasd dyzsasd pushed a commit to dailymotion/boto that referenced this issue May 9, 2017

@JordonPhillips JordonPhillips Merge pull request #527 from JordonPhillips/update-s3-user-guide
Update S3 user guide
e4ca62c
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment