Determine Best Project/File Integration Technique

[GabeStah]

Repository

Using example: https://github.com/GabeStah/Airbrake.io

• owner: Owner name (e.g. GabeStah)
• name: Repo name (e.g. Airbrake.io)

Prisma

Note: Consider integrating Prisma and/or graphql-yoga.

Configuration

module.exports = {
  repositories: [
    {
      owner: 'GabeStah',
      name: 'Airbrake.io',
      client: {
        name: 'Airbrake.io',
        url: 'https://airbrake.io/',
        tagline: 'Application monitoring for your entire stack.'
      },
      projects: [
        {
          path: 'Pitches/Languages/Ruby/Rails/RectoringFatModels',
          // TODO: Glob support
          // See: https://github.com/isaacs/node-glob
          writ: ['text.md', 'text-part-2.md'],
          options: {
            hasMetaDescription: true,
            hasSources: true
          }
        },
        {
          path: 'Pitches/DevOps/DevOps%20Best%20Practices',
          writ: ['text.md'],
          options: {
            // Default: true
            hasFrontMatter: true,
            hasMetaDescription: true,
            hasSources: true
          }
        },
        {
          path: 'Pitches/How%20to%20Make%20a%20Twitter%20Bot',
          // Get all markdown files in root directory.
          writ: '*.md',
          // All png and jpg files in root directory.
          assets: ['*.png', '*.jpg'],
          options: {
            // Default: true
            hasFrontMatter: false,
            hasMetaDescription: true,
            hasSources: true
          }
        }
      ]
    }
  ],
  projects: [
    {
      repo: 'GabeStah/dgraph-reddit',
      // TODO: Glob support
      // See: https://github.com/isaacs/node-glob
      files: []
    }
  ]
};

Projects

Need way to differentiate between separate projects, particularly multiple projects within single repo. For example, https://github.com/GabeStah/Airbrake.io/tree/master/What%20Is contains dozen+ projects by directory. However, https://github.com/GabeStah/Airbrake.io/tree/master/Exceptions contains parent directories, each of which contains a unique project.

Images

How to maintain internal references to assets (e.g. images). For example, Twitter Bot contains references to internal images.

Extract Non-Front Matter Meta

See: https://github.com/GabeStah/Airbrake.io/blob/master/Pitches/Languages/Ruby/Rails/RectoringFatModels/text.md

Possible Solution: Use unified plugin to parse for ---\n\n__META DESCRIPTION__, ---\n\n__SOURCES__, and so forth.

Methods for Obtaining Git Repo Content

• git clone to local repo copy.
  • Once local repo exists can perform future updates by comparing hash of latest commit, and if new, perform git remote update or git fetch.
• Use GitHub API to retrieve temporary tarball URL, download, and extract local copy.