One post tagged with "Documentation"

Frontend Build Status​

Overview​

The Winner Is a Tryhard is now a Docusaurus site hosted on Netlify replacing the vanilla React frontend and Lambda backend for serving dynamic content. It uses Markdown (or MDX) syntax for writing blog posts, which should streamline the writing process for everyone. By utilizing the pull request system on GitHub, the publishing process will also be self-service thanks to the Netlify CI/CD tooling. This documentation will cover:

• Creating and configuring your GitHub account and keys
• Setting up your local development environment
• Cloning the project to your local machine
• Creating a new post
• Writing the post using Markdown
• Submitting a pull request

Creating and Configuring Your GitHub Account​

If you don't have an account already, join here. After that, submit a request to join The Winner Is a Tryhard on GitHub. Once you have been added, you will have permission to modify existing Git repositories and create new ones.

Setting Up Your Development Environment​

Make sure you have the following software installed:

• Git
• Node.js
• A code editor like Visual Studio Code
• A terminal emulator like iTerm 2 for macOS, Git BASH for Windows, etc.

Test to make sure your software is installed correctly by running a few commands. Assuming the following statements return version numbers instead of throwing errors, everything installed successfully.

git --version
node --version
npm --version

Configuring SSH Keys and Git​

In order to push commits to the remote origin from your local machine, you'll need to create a new SSH key and add the key to your account. Set up your global name and email on your machine as well.

git config --global user.name "Your Name"
git config --global user.email "youremail@yourdomain.com"

Cloning the Repository and Starting the Web Server​

With the previous steps completed, you can now clone the repository to your local machine and start the local web server.

git clone https://github.com/scottenriquez/scottie-is-xxx-v3.git
cd scottie-is-xxx
npm run start

Navigate to http://localhost:3000 in the browser.

Creating a New Branch​

If your terminal or editor doesn't automatically show you which branch you're working in, use the git status command to find out. Don't commit any new posts directly to the main branch. Instead, create a new branch for a specific purpose (i.e., scottie-power-rankings-week-one) locally and push it to the remote origin.

git checkout -b scottie-power-rankings-week-one
git push origin -u scottie-power-rankings-week-one

Creating a New Post​

Use the power rankings CLI to generate new posts. The generated template lists each league member with fantasy football data from Sleeper and their avatars stored on a CDN.

---
title: "Scottie's Week One Power Rankings"
date: "2020-08-22"
description: "Scottie's dope power rankings."
authors: [scottie] 
---

## <img src="https://twiath-site-cdn.s3.amazonaws.com/nfl_dal-one-scottie" class="sleeper-avatar"/> 🏆‼️ | 0-0W/L | 0PF

## <img src="https://twiath-site-cdn.s3.amazonaws.com/1bac27b3e88d08f050e32b48195acf46-one-scottie" class="sleeper-avatar"/> markhambone | 0-0W/L | 0PF

## <img src="https://twiath-site-cdn.s3.amazonaws.com/400266e997f2d0857da2c8f2b939fda4-one-scottie" class="sleeper-avatar"/> BigOleDoinks | 0-0W/L | 0PF

## <img src="https://twiath-site-cdn.s3.amazonaws.com/405213591fe488220f2f4f79d9cc28eb-one-scottie" class="sleeper-avatar"/> Glizzy Guzzlers | 0-0W/L | 0PF

## <img src="https://twiath-site-cdn.s3.amazonaws.com/379f5379a3205b9706e6a4b7b4471a8e-one-scottie" class="sleeper-avatar"/> Manhattan (KS) Miracles | 0-0W/L | 0PF

## <img src="https://twiath-site-cdn.s3.amazonaws.com/1fe089e517448d9fe207b8607ca8e81b-one-scottie" class="sleeper-avatar"/> jyarrow | 0-0W/L | 0PF

## <img src="https://twiath-site-cdn.s3.amazonaws.com/49b1d67d6b1562f8ef7d03645a046694-one-scottie" class="sleeper-avatar"/> Bijan Mustard | 0-0W/L | 0PF

## <img src="https://twiath-site-cdn.s3.amazonaws.com/23fe4994d864928df8f99d56b60c9179-one-scottie" class="sleeper-avatar"/> lrich91 | 0-0W/L | 0PF

## K(icker) Man | 0-0W/L | 0PF

## <img src="https://twiath-site-cdn.s3.amazonaws.com/d57bddeb09e102a2b7556973dc6301fb-one-scottie" class="sleeper-avatar"/> Court is in Sutton | 0-0W/L | 0PF

## <img src="https://twiath-site-cdn.s3.amazonaws.com/61bfca158073b2dda70f755d92aacad9-one-scottie" class="sleeper-avatar"/> CDC Lamb | 0-0W/L | 0PF

## <img src="https://twiath-site-cdn.s3.amazonaws.com/320f9195b391718105e27b8cc9d40277-one-scottie" class="sleeper-avatar"/> almostwinning | 0-0W/L | 0PF

Using Markdown​

The section wrapped in --- is called the slug. It contains metadata for querying posts using GraphQL. ## wraps proceeding text in an <h2> tag. All other text gets wrapped in a <p> tag. Markdown offers many powerful features such as embedding images, creating hyperlinks, and adding syntax highlighting. The site can serve image content as well. You can add an image file to the same directory as the index.md and embed using a local path (i.e., ![Image description](./image.png) in index.md for the directory below).

├── assets
│   └── champion.png
└── blog
    └── posts
        └── contribution-documentation
            ├── image.png
            └── index.md

MDX​

This site is configured to support MDX. MDX adds a new dimension of features in Markdown pages by seamlessly integrating JSX, which allows for writing HTML inside of JavaScript statements.

const element = <h1>Hello, world!</h1>

Markdown syntax is simple and allows for content structuring, but the ability to write JavaScript inside of it allows for dynamic content such as charts and HTTP calls. The MDX syntax for adding React components is straightforward.

import MyReactComponent from '../src/components/myReactComponent'

# H1 Text

This gets wrapped in a <p> tag.

<MyReactComponent input={'Hello, world!'} />

Committing, Pushing, and Submitting a Pull Request​

Once you've finished writing your content, publishing your changes is automated via CI/CD. First, commit and push to your branch.

git add .
git commit -m "Adding my super thoughtful power rankings"
git push origin scottie-power-rankings-week-one

From the GitHub web UI, open a pull request and select your branch with the changes. Add @scottenriquez. Once approved, your post will be published via Netlify's integration.

Power Rankings CLI Overview​

spr is a CLI tool for generating Markdown pages in the league site for power rankings posts with Sleeper data injected. The source code is hosted on GitHub.

Build Status​

Installation and Dependencies​

Clone the repository, install NPM dependencies, and create a symlink in the global folder.

git clone git@github.com:the-winner-is-a-tryhard/power-rankings-markdown-cli.git
cd power-rankings-markdown-cli
npm install
npm link
spr --version

The CLI source code doesn't store any secrets, so ensure that the AWS CLI is installed and that the credentials are configured at ~/.aws/credentials.

[default]
aws_access_key_id=AKIAIOSFODNN7EXAMPLE
aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

If not, run aws configure.

Usage​

Navigate to the root folder of the league's site, and run spr add <WEEK_NUMBER> <AUTHOR_FIRST_NAME>. The alias for add is a. Open the generated index.md file in the newly created directory (<FIRST_NAME>-week-<WEEK_NUMBER>-power-rankings/) to enter the power rankings text for the new post.

Functionality​

• Validates the week number and author first name
• Checks the current Git branch to ensure that the user has created a non-main branch
• Fetches the league members and rosters from the Sleeper API
• Fetches the current avatar for each league member and copies to a CDN hosted in AWS
• Generates Markdown power rankings with the member's latest stats neatly formatted
• Creates a new directory for the post and writes the index.md file

Configuration​

The league-specific details exist in various JavaScript configuration files to maximize reusability. While the CLI is tightly-coupled with Docusaurus, there's still much that can be reconfigured for other leagues.

Frontend​

const frontend = {
  // used to determine if the user created a new branch
  mainBranchName: "main",
  // used to determine if the user is in the root directory
  configFileName: "docusaurus.config.js",
  // used to support any changes to the default blog path for vanity URLs
  postPath: "/twiath/",
  // used to defer image styling for the avatar 
  avatarHTMLClass: "sleeper-avatar",
}

AWS​

const awsConfig = {
  // S3 bucket
  bucketName: "twiath-site-cdn",
  // URL base to be used for source in <img> tag
  cdnURLBase: "https://dxyip34awyjyf.cloudfront.net",
}

League​

const league = {
  // Sleeper league ID number
  id: "541384381865115648",
}

Authors​

const authors = {
  Scottie: "Scottie Enriquez",
  Callen: "Callen Trail",
  Logan: "Logan Richardson",
  Carl: "Carl Meziere",
  Andrew: "Andrew Carlough",
  John: "John Yarrow",
  Matt: "Matt Kniowski",
  Chris: "Chris Ramsey",
  Caleb: "Caleb Trantow",
  Travis: "Travis James",
  Trond: "Trond Liu",
  Mark: "Mark Hamilton",
}

Weeks​

const weeks = {
  0: "zero",
  1: "one",
  2: "two",
  3: "three",
  4: "four",
  5: "five",
  6: "six",
  7: "seven",
  8: "eight",
  9: "nine",
  10: "ten",
  11: "eleven",
  12: "twelve",
  13: "thirteen",
  14: "fourteen",
  15: "fifteen",
  16: "sixteen",
  17: "seventeen",
}