Almanac.httparchive.org: Create templates for content pages

Created on 13 Jun 2019  路  5Comments  路  Source: HTTPArchive/almanac.httparchive.org

We don't have chapters written yet but now would be a good time to create the infrastructure for them so we can just drop in the content when they're ready.

I'm working with a designer to create the look and feel, which should be ready by July. Meanwhile we can get started on the backend routing and templating in preparation.

We should create the following templates:

  • [x] rename the splash page at index.html to splash.html and update main.py
  • [x] create a new index.html for the post-launch home page, stub things like navigation and introductory text
  • [x] create /2019/outline.html where we show a table of contents for all chapters
  • [x] create /2019/chapter.html as a template for each chapter
  • [x] create /2019/methodology.html to provide technical info about our test methodology
  • [x] create /2019/contributors.html to acknowledge everyone who contributed to the project

The Almanac is an annual report and I expect to do this again next year, so we should be proactive and separate the annual content from the static content. In this case, the home page is static to the project while things like table of contents, chapters, methodology, and contributors may change year to year. These should all be organized in a 2019 template directory.

The contributors page will be based on the data in this sheet. It might be a good idea to create a JSON metadata file of all contributors and generate this page dynamically. This way we can also dynamically add authors/reviewers on the bylines of their respective chapters.

Any volunteers from @HTTPArchive/developers who can take part or all of this issue?

development

All 5 comments

I part want to help.

Isn't it a problem to create a public web API use Google SpreadSheet script?

I made the next simple script. (I can not add this script to the original because I have no authority)
https://gist.github.com/MSakamaki/795b4c947fb0fdfc8e41d320e6e5ddc1

This points to my sheet where I copied the contributors page.
https://docs.google.com/spreadsheets/d/1DB0dhdgRiWfAeH5gTEd7nd3zsEuaNCMqp0gA1IGVzUA

When you hit the following API, you get json of name and hyperlink.
https://script.google.com/macros/s/AKfycbzuHDBRkaOlOi_iioNVKYQxVpQ4mZJy2V8xVS_l9FJM0eF3zhPq/exec

If there is no problem, we will start producing json API including the role.

I can take care of the scaffolding

To clarify, I meant using a server side JSON file to maintain the contributors list. The Sheet was just an example of the current list 馃檪

@rviscomi
Oh, I understand. Thank you for your explanation!

The templates exist, but we still need to write content for them. We can do that in follow-up issues.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

obto picture obto  路  5Comments

rviscomi picture rviscomi  路  5Comments

bazzadp picture bazzadp  路  4Comments

bazzadp picture bazzadp  路  4Comments

rviscomi picture rviscomi  路  6Comments