/wgtwo.com

Primary LanguageTypeScript

Working Group Two (wgtwo.com)

Create a Blog

  • Upload images at static/img/blog/
  • Add your blog post here blog/
    • Keep the structure yyyy-mm-dd-name-of-blog.md
    • Ensure you add a <!--truncate--> after the first paragraph of your blogpost to truncate the text for when viewing at wgtwo.com/blog. If not, the entire blog post will be displayed

Example simple blogpost

2022-02-02-how-to-write-a-blog-post.md
---
slug: log4j-security-vulnerability
title: "Zero-day vulnerabilities - Log4j"
date: 2021-12-17
tags: [security, infrastructure, vulnerability]
author: Jonnathan Griffin
author_title: Security Engineer
author_url: https://www.linkedin.com/in/jonnathangriffin/
author_image_url: https://media-exp1.licdn.com/dms/image/C4E03AQEjrF7PC8veoQ/profile-displayphoto-shrink_400_400/0/1624522450808?e=1648684800&v=beta&t=LZVAsE5hVp3T50zGPk0qkf8qPJCnsXBlBXfCosrTH5o
---

This will be viewed from wgtwo.com/blog and should be short.

<!--truncate-->

Now my real blog post begins ... ...

Create a Docs

Markdown Tutorial

For the Docs and Blog, markdown is used. Here is a great example https://stackedit.io/

In short, the main things to know for markdown

## This is large header

normal paragraph with then **bold** text and *italic* text

Image for a docs
![](images/wgtwo-skier-1.png)  

Image for a blog
![](/img/blog/log4j/01-canary-tokens.png)

Normal link to a website
[Description of your link](www.wgtwo.com)

Image with set width

Image on the right side
<img width="50%" align="right" style="display: block; margin:40px auto;"
     src="/img/blog/log4j/01-canary-tokens.png"/>

Image with 300px
<img src="/img/blog/voicemail.jpeg" alt="Breaking up via voicemail" width="300"/>

Website Development

Expert

The website is built using Docusaurus, React, and Typescript. This allows for custom complex integrations using APIs, as well as, the simple updating docs and blogs with markdown.

To run the website locally with hot reload:

cd website
yarn install
yarn start

Before pushing to prod, it is recommended to test with yarn build. There can be oddities with CSS changes for when React will generate the html. To test this,

cd website
yarn build
yarn run serve
yarn prettier

Note: If making a PR, a yarn prettier check is performed and will fail the PR if issues.

Website structure

$  tree -d -L 4
.
├── blog
├── docs
│   ├── about
│   ├── case-studies
│   ├── images
│   │   └── wgtwo-logos
│   └── technology
└── website
    ├── src
    │   ├── components
    │   │   ├── apply
    │   │   ├── brands
    │   │   ├── casestudy
    │   │   ├── cta
    │   │   ├── enterprise
    │   │   ├── hero
    │   │   ├── integrations
    │   │   ├── interview-process
    │   │   ├── logs
    │   │   ├── multig
    │   │   ├── ourservice
    │   │   ├── quote
    │   │   ├── rbe
    │   │   ├── security-domain
    │   │   ├── security-header
    │   │   └── technologymetrics
    │   ├── css
    │   ├── pages
    │   └── util
    ├── static
    │   ├── img
    │   │   ├── blog
    │   │   ├── favicons
    │   │   └── team
    │   └── video
    │       └── blog
    └── theme
        ├── BlogListPage
        ├── BlogPostItem
        ├── BlogPostPage
        ├── BlogSidebar
        ├── BlogTagsListPage
        └── BlogTagsPostsPage

Deployment

Commit to main branch -> github action to perform yarn build -> website deployed to gh-pages branch

All PRs are also tested with a github action.