grow / fileset

Grow.dev

Grow is a declarative tool for rapidly building, launching, and maintaining high-quality static HTML.

• Easy installation
• Jinja template engine
• Content managed in YAML and JSON files
• Data-binding between content and templates
• Configuration-based site architecture
• Easy URL changes
• Flexible internationalization and translation
• Integration with external CMSes
• Integration with Google Sheets
• Fast builds

Quick start

One time only: install Pipenv and libyaml.

# On Mac with Homebrew (https://brew.sh/).
brew install pipenv libyaml

# On Ubuntu.
sudo apt install -y pipenv libyaml-dev

# On other distributions.
sudo apt install python-pip; pip install pipenv

Next: install and run Grow using a starter.

git clone https://github.com/grow/starter
cd starter
pipenv install
pipenv run grow install
pipenv run grow run

Documentation

Visit https://grow.dev to read the documentation.

fileset's Issues

[FEATURE] Experiments framework

Some quick thoughts about an experiment framework:

• Files stored as:
  • default: /{path}/{filename}.html
  • experiment: /{path}/{filename}.{experiment}.html
• Experiments enabled/disabled (by % of users) using a UI
• Experiments can span multiple files
• Once a user is segmented into an experiment, all subsequent requests from that user should return files for that experiment
• Admins can enable/disable experiments using a query param, e.g. ?e={experiment} to enable ?e=-{experiment} to disable. ?e=Experiment1,Experiment2 to enable multiple experiments.
• Admins can view their enabled flags using a URL (I forget what's standard, but maybe something like /_fs/flagz)

Some things to figure out:

• How would we handle multiple experiments on a single file?
• Should we enable some basic server-side rendering logic, e.g. [[ if Experiment1 ]] show this [[ /if ]]?

Fix soft 404s

404 pages should return a 404 response code, rather than a 200 (a "soft 404").

Example:
https://wing.com/404.html

This cropped up in Google Search Console.

Support for GAE services

Major site redesigns sometimes use separate GAE services for code separation / isolation, which services at URL format <service>-dot-<appid>.appspot.com.

• Branches need to be aware that they are serving inside of a service.
• Datastore should isolate data between different services.

[FEATURE] Python 3 support

The server-side code needs to be compatible with Python 2 and 3 without any extra work from the developer.

Support for multiple domains on the same app

Should be able to map multiple domains to the same fileset server, serving different manifest files.

Deployment config in grow would be something like:

deployments:
  # deploys to example.com and all other domains
  default_domain:
    destination: fileset
    branch: auto  # Uses the git branch name.
    server: appid.appspot.com
    env:
      name: prod
      host: example.com
      scheme: https
  # deploys to foo.example.com
  subdomain_foo:
    destination: fileset
    branch: auto  # Uses the git branch name.
    server: appid.appspot.com
    domain: foo.example.com
    env:
      name: prod
      host: foo.example.com
      scheme: https
  # deploys to bar.example.com
  subdomain_bar:
    destination: fileset
    branch: auto  # Uses the git branch name.
    server: appid.appspot.com
    domain: bar.example.com
    env:
      name: prod
      host: bar.example.com
      scheme: https

[FEATURE] Action logs

Fileset should record "actions" taken by user in a log-style format, and developers should be able to query those logs either through an admin UI or through bigquery or something similar.

[FEATURE] UI for showing the current and latest manifests for a branch

There should be a UI that shows the current manifest for a branch, along with past manifests (along with who uploaded the manifest and the time it was uploaded) in case rollbacks are needed. Should also have a button to be able to rollback to a previous manifest.

[BUG] Support HEAD requests

HEAD requests should be a GET request with no body content.

Add country's official languages to intl fallback mechanism

For regionalized content that should be displayed for users in a given country, the current fallback system fails unless the user has one of the languages of that country listed in their browser's language preferences. The fallback mechanism should look for files that match the country's official languages in addition to the browser's language preferences.

The babel package would need to be included as a dependency. Projects would need to update their app.yaml file to add this dep to their app.

>>> from babel import languages
>>> languages.get_official_languages('fi')
(u'fi', u'sv')

[FEATURE] Preview future deployments in staging URL

Users should be able to visit a staging link and be able to preview future deployments. Should work on Env.STAGING domains only (aka .appspot.com), which already enforce authentication.

JS and CSS files loaded will need to also respect this query param, probably through the Referrer header.

[FEATURE] Support google cloud image params for image files

Users should be able to provide a query param to pass to image paths, which would redirect to a Google Cloud Image URL. Since the file would already be stored on GCS, we'd just need to generate the URL using the Google Images Python API and then pass any formatting params documented in grow-ext-google-cloud-images.