Assignment 11 - Static Content Generators¶

This will be a group project. However, grades will be individual.

Restructured Text Reference: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

Getting Started¶

Here are the steps to get started:

Get together with your group.
Select a project idea. Last year’s topics were video game reviews, movie reviews, Indianola destinations, and common internet scams.
Notify the instructor of your idea.
Elect one person to create a new project from the template.
Send out invites to the project.
Accept the invitation.
Use the “project” part of your GitHub project to brainstorm ideas for what pages to create.
Select two pages to create
Clone the project
Make sure you can build the project
Write your pages (at least 700 words total)

Make The Web Pages¶

Create two web pages that have:

700 words that you wrote, total. Quotes don’t count towards the total. Don’t copy from other websites, it is too easy to find.
Paragraphs. Don’t give me a wall of text. Review how to write a paragraph.
Headings. Take a look at the outline generated when you create a document. Each page should have one, and only one, level one heading. A page that doesn’t have any headings might not show up. A page with multiple top-level headings will have each top-level heading show up like they are different pages. Be very deliberate about your heading choices.
Images. and/or figures. Properly sized images. Do not squish a 4000 x 3000 pixel photo you took into a 400x300 spot. Change the image. You’ll make a faster web page and save everyone money on bandwidth. Also, keep aspect ratios. Don’t specify both width and height at a different ratio that stretches the image. I just specify width only and let the browser pick the right height.
Cite an image that you use that is not your own. See Citations below. Find the original source. Don’t cite IMDB or Google Images for a movie poster, cite the studio that made it.
Tables
Links outside the document
Links inside the document (references)
Update the table of contents with your pages
Multiple types of in-line styles. But don’t change the style in a heading!
Don’t copy/paste curly quotes from a word processor into your text. Use straight quotes.
Name your pages and directories according to their content. This helps their ranking in Google, as well as helping you keep things straight. So, for example, xbox_360.rst is a much better name for a page about the XBox 360 than a page named page4.rst.
Try adding a note or warnings.
Follow the tutorials for Hosting on S3 and CloudFront.
When you’ve deployed to S3 and CloudFront, check and make sure your images work and your links. Amazon cares about the case of your file names, and if you’ve ignored my advice at making everything lower case, it may haunt you here.

Warning

Avoid using ‘bold’ on headings, as they are already styled. Don’t do this:

**My Heading**
--------------

Citations¶

To cite an image or information from an external source, you may use Restructured Text’s footnote. Use the footnote directly in the text where the information comes from, or as a caption an the image if you are using an image. For example:

Inez Milholland [1]

The code for this looks like:

.. figure:: milholland.jpg
   :width: 300px

   Inez Milholland [#f1]_

The rest of the text of your page would go here under your image. Then finally at the end of the page, you can list out your footnotes:

[1]	“Inez Milholland”. Vassar College Encyclopedia. 2006. Retrieved 2012-07-21.

And the code for that looks like:

.. [#f1] "`Inez Milholland <http://vcencyclopedia.vassar.edu/alumni/inez-milholland.html>`_".
   Vassar College Encyclopedia. 2006. Retrieved 2012-07-21.

Alternatively, you can use Restructured Text’s references directive to link a citation, and at the end of the document format the citation using APA style.

Cite the original source. If you cite something like Google, Amazon, Wikipedia, or IMDB I’ll not give any points. These companies rarely create content. You might find the image or information with their tools, but then use some detective work to find the original source. For example, a movie poster might be on IMDB.com, but the original source might really be Warner Brothers.

Also, you might find yourself wanting to list a website as a source. Remember that the source isn’t “wsj.com”, the source is “Wall Street Journal.” Sometimes the “about” page has this information. If you can’t figure out who the publisher is, it probably isn’t a good source.

If using an auto-citation formatter, beware of “n.p.” for no publisher and “n.d.” for no date. If I see a publisher immediately followed by “n.p.”, it indicates that not much thought was put into the citation. If you can’t figure out the entire date, at least try to narrow it down to the month or year.

I don’t want to see the text of a URL, but please do use a link to reference the original source as shown in the example above.

Remember: A list of URLs is never ok for a bibliography.

Teamwork¶

If no one else is taking a lead in the project, don’t hesitate to step up and do it yourself. If someone else is leading, step up and lead your own part of the project.

It is not unusual for team members to fail and hold up their end of the project. This is a great time to practice your ability to encourage others to engage. Send people a reminder outside of class. But don’t be a jerk about it, as we never really know what is going on with someone else’s life. Help pull someone up. Never push someone down.

Get as much work done outside of class as you can. It is disrespectful to your teammates if they come to class with a draft of their work, and you are busy trying to just get started writing it.

Turn In¶

Clearly label and turn in the following links. Do not just give me a list of links.

Link to the GitHub project page. This should be the same for every person in the group.
Link to each GitHub page that you created. Do not link pages that show someone else checking in this page. Please link to the source file, not the commit.
GitHub URLs of GitHub issues you worked on. There should be one issue for each page.
Link to your S3 bucket website. This is the link that shows your website, not the AWS management page, which I can’t see. Double-check that it has your latest code, as I’ll look at this when I grade.
Link to your Cloud page.

Rubric¶

Important End of Term Reminder¶

After grades are posted for this class, remember to:

Stop your EC2 web server. You can terminate it (make it go away) or just stop it.
Remove your S3 bucket.
Remove your CloudFront link.

Or, just terminate your account once everything is graded. Please don’t terminate it before I grade your projects.

This will help make sure that you don’t get any unexpected fees charged to your credit card.