Skip to content

README.md

Latest commit

 

History

History
53 lines (42 loc) · 1.68 KB

README.md

File metadata and controls

53 lines (42 loc) · 1.68 KB
Raw

the orange storage*

*to be completed. for now, make a pr in the-orange-blog and dm either raptorly1 or orangememoryyarn on discord to get your pr approved

What is it?

The Orange Storage is where we store all our articles in markdown!
To use our articles with both book and blog, we needed a single place to keep the files: here! Here's how the current update process works:

%%{
  init: {
    'theme': 'base',
    'themeVariables': {
      'primaryColor': '#44a6d0',
      'primaryTextColor': '#fff',
      'lineColor': '#6e5de0',
      'borderStrokeWidth': '2'
    }
  }
}%%

 flowchart TB
    A[Contributor opens a PR] ==> Z(Review)
    Z ==> K(PR approved)
    Z ==> L(PR rejected)
    L ==> M(Contributor fixes the PR)
    M ==> Z
    K ==> B(Updaters read the file during daily/hourly cycle)
    B ==> C(Blog Updater reads the md file)
    C ==> D(Blog Updater makes a commit in blog with the md file)
    B ==> E(Book Updater reads the md file)
    E ==> F(Book Updater passes the md file to the formatter)
    F ==> G(Formatter in The Orange Book turns it into an html file)
    G ==> H(Formatter makes a commit in the book with the html file)
    H ==> I{Github Pages updates}
    D ==> I
Loading

It's all automatic!

Doing it this way:

  • saves time (we don't need to convert docs manually)
  • ensures consistency (we'll never need to worry about document versions across the book and blog)
  • avoids error (no more markdown files for us to move around)

Can I read it as a blog?

Yes! The orange blog can be found here!

Can I contribute?

Yes! We welcome contributions. If you'd like to help out, open a PR!