Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Set up the template repository structure #21

Closed
jaredmorgs opened this issue Nov 3, 2019 · 2 comments
Closed

Set up the template repository structure #21

jaredmorgs opened this issue Nov 3, 2019 · 2 comments
Assignees
Milestone

Comments

@jaredmorgs
Copy link
Contributor

Based on the discussion between @cwcromwell and @jaredmorgs in the Templates Slack channel, the following structure was decided upon to make use of both templates.

Task

  • Implement the following starting point structure
  • If templates are already provided by Clarence or Jared, move them into this directory structure.
  • If no templates are created yet for the file types, create a bug to track the requirement.

Agreed Structure

/templates/

/templates/overview

  • about-overview.md
  • template-overview.adoc
  • template-overview.md

/templates/discussion

  • about-discussion.md
  • template-discussions.adoc
  • template-discussions.md

/templates/best-practice

  • about-best-practice.md
  • template-best-practice.adoc
  • template-best-practice.md

/templates/tutorial

  • about-tutorial.md
  • template-tutorial.adoc
  • template-tutorial.md

/templates/quickstart

  • about-quickstart.md
  • template-quickstart.adoc
  • template-quickstart.md

/templates/how-to

  • about-how-to.md
  • template-how-to.adoc
  • template-how-to.md

/templates/logging

  • about-logging.md
  • template-logging.adoc
  • template-logging.md

/templates/api-endpoint

  • about-api-endpoint.md
  • template-api-endpoint.adoc
  • template-api-endpoint.md
@jaredmorgs jaredmorgs added this to the 0.1WtDConf milestone Nov 3, 2019
@camerons camerons self-assigned this Nov 3, 2019
camerons added a commit that referenced this issue Nov 3, 2019
Restructured directory and renamed files. Addressing issue #21.
@camerons
Copy link
Member

camerons commented Nov 3, 2019

I've moved existing files to fit this structure (now in master). There are still files to create and content to move around within the files.

@jaredmorgs
Copy link
Contributor Author

I have created the files and moved the content around in the #23 commit.

camerons pushed a commit to camerons/templates that referenced this issue Feb 27, 2021
Adds explanation of what to do with the structured metadata script tag, and formats it as a code example rather than plain text on the page. Addresses issue 21: thegooddocsproject/incubator#21
camerons pushed a commit to camerons/templates that referenced this issue Feb 27, 2021
camerons pushed a commit to camerons/templates that referenced this issue Feb 28, 2021
Adds explanation of what to do with the structured metadata script tag, and formats it as a code example rather than plain text on the page. Addresses issue 21: thegooddocsproject/incubator#21
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants