Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ReadMe/Contributing docs to include instructions for adding blog posts #192

Open
1 of 10 tasks
theecrit opened this issue Jul 10, 2021 · 1 comment
Open
1 of 10 tasks
Labels
documentation maintaining or creating documentation about the project

Comments

@theecrit
Copy link
Collaborator

theecrit commented Jul 10, 2021

What are you submitting?

Place an x in the appropriate bracket:

  • Bug (something's broken)
  • Feature request or improvement
  • Content update
  • Question
  • Other

Description

Update ReadMe/Contributing docs to include instructions for adding blog posts:

  • Include details about front matter requirements like post-excerpt and author
  • Include instructions for blog header images (front matter, alt text, etc)
  • What to include in post footer for Voices series
  • General editorial guidance
  • Instructions for waiting 36 hours to merge minor changes after requesting review and 72 hours for major changes.

Related: #183

Thank you!
@theecrit theecrit added the documentation maintaining or creating documentation about the project label Jul 10, 2021
@theecrit theecrit added this to Backlog in Ongoing improvements backlog via automation Jul 10, 2021
@theecrit theecrit moved this from Backlog to Ready to work on in Ongoing improvements backlog Jul 10, 2021
@theecrit
Copy link
Collaborator Author

Cheat sheet for configuring includes:

You'll need to create three files:

  • MD file: the markdown file gets converted to your web page and holds the include (stored in the src folder)
  • HTML file: the html file is the include that formats how the data will appear once embedded in your markdown file (stored in the src/_includes folder)
  • YAML file: the data to be pulled into the include (stored in the src/_data folder)

In the YAML file:

  • List your data instantiations here.
  • Syntax and spaces matter! Your best best is to copy and paste an existing YAML file in the _data folder, and replace the variables you'd like to use.

In the HTML include file:

  • This contains the HTML code for how you want the data instantiations to display in the UI. Use Jekyll syntax to call the data variables you want to display.

In the markdown file:

  • Add your include where you want it to appear: {%- for include-name in site.data.includeYAMLfileName -%}. This pulls in the HTML _include file and populates it with with data instantiations from the YAML file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation maintaining or creating documentation about the project
Projects
Development

No branches or pull requests

1 participant