Skip to content

Transitioning to the new website

Michael Glukhovsky edited this page Mar 27, 2015 · 9 revisions

Documentation updates

  • Documentation articles should now include an intro paragraph (or set of paragraphs), followed by a Kramdown tag that will generate a table of contents, and an illustration (if applicable).

Here's an example, for the "Table joins in RethinkDB article:

{% infobox info %}
__Wondering how to model your data?__ Read about [data modeling in RethinkDB](/docs/data-modeling).{% endinfobox %}

Like many traditional database systems, RethinkDB supports `JOIN`
commands to combine data from multiple tables. In RethinkDB joins are
automatically distributed — a join command is automatically sent
to the appropriate nodes across the cluster, the relevant data is
combined, and the final result is presented to the user.

Let's see how we can use joins in RethinkDB to query data based on
__one to many__, and __many to many__ relations.

{% toctag %}

<img src="/assets/images/docs/api_illustrations_redone/table-joins_background.png"
     alt="Table Join Illustration"
     class="api_command_illustration" />
  • Remove the active: docs header from all documentation Markdown files (this header is included in the layout, it doesn't need to be in the content).

  • Make a list of images that need to be resized to full width (or other sizes, please specify). This could include screenshots, illustrations, or other images. The list is included below:

    • [add docs / images here]

Infoboxes

  • The infobox Liquid tag should be more stable, so inline HTML infoboxes should try to be converted to the infobox liquid tag where possible.
  • The default color is blue, and there is no more info style for infoboxes (as this is their default state), so these should be converted to the simple infobox where possible.
  • A new infobox style, alert, is available for yellow infoboxes (cautions and alerts).

YAML header updates

  • Remove the js header, we're using body_class to decide what JavaScript files to load instead. (note: js is used correctly for the language switcher in some documentation articles.)

Liquid updates

  • The new default filter should replace all instances of:
{% if x %}{{x}}{% else %}this is the default{% endif %}

with:

{{ x | default 'this is the default' }}

Blog posts

  • Blog posts need YAML header changes:
    • author_github should change from a URL to the GitHub username
    • Reconsider / review tags
  • Rework blog posts to include a cover image if possible -- this may simply require reordering content within posts.
  • Rework blog post cover images to use a consistent aspect ratio / whitespace (visual scan -- does anything look weird?)

Fixing bad behavior

  • Replace all instances of -- with &mdash;
  • grep for all inline styles in Markdown files (e.g. blog posts) and aggressively prune them out
  • Remove unnecessary inline HTML wherever possible (e.g. blog posts) in Markdown files