Skip to content

Processes

Jan Rous edited this page Apr 3, 2020 · 5 revisions

Processes for getting things done

This page describes the current processes we have defined to get things done. Please follow this as best as you can and if something is not clear or satisfactory, ask the relevant team lead

Getting new content up

  1. Anybody can submit a content suggestion or change request via a ticket here. This is open to the general public.
  2. Volunteers who were onboarded to the collective's Slack can also join #english-content and suggest new content, please refer to our editorial guidelines before to speed up the process.
  3. #Reviewers will pick-up the content suggestions both from GitHub issues and #english-content and prioritize according to this criteria
  4. [#Reviewers] will ask [#information-arch] where to add the content if it's not an existing section.
  5. [#Reviewers] can create or modify the content themselves (instructions) or ask the Tech team for help.
  6. Once the PR is ready to be merged, 2 #Reviewers are needed to approve it.
  7. When the PR is approved, deployment happens automatically to the live website and the new content is sent to Localize for translation.

RESOURCES

Our resources page is a public repository of useful and interesting resources.

Anybody can add resources using this form. The responses are stored in this google sheet. If authors indicate that the resource complies with FTC guidelines, google apps script that runs on the spreadsheet (Tools > Script Editor) will automatically copy relevant fields to the Approved Resources tab of the same sheet.

The script will also notify slack channel #resources about the new submission.

Once a day, github action import-new-resources.yml runs import_resources.py script and generates pull request if changes to MD files under _resources/ are detected. Simply approve this PR to integrate new resources to the website.

Operational instructions

  • If you need to prevent resources from being integrated you can clear the content of the approved_by column in the Approved Resources. import_resources.py will skip over these rows.
  • If you need to remove already integrated resource, make sure that it won't be picked up by import_resources.py by following the above step and then simply remove the offending md file from the repository.
  • If you need to manually add new resources, you can simply add rows to Approved Resources sheet.