Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Middleman Blogging for making guides #12

Merged
merged 16 commits into from
Jan 22, 2018

Conversation

alexcu
Copy link
Member

@alexcu alexcu commented Oct 22, 2017

This PR refactors Middleman Blogging into the Guides.

The directory structure has been modified to make the root publication directory articles, which encompass guides, installation and contribution.

To create a guide run:

bundle exec middleman article [Name of Article] -t [tag]

This will produce a new guide with a timestamp under articles/guides. The [tag] must be set to an api_group, such as the existing json, utilities, and database guides. The basic structure of a guide is a Markdown file that contains the following frontmatter:

---

title: Sample Guide using Middleman Blogging
date: 2017-10-03 06:21 UTC
author: Alex Cummaudo
author_url: http://github.com/alexcu
tags: graphics
summary: |
  This is a summary of the article that should be no more than two 
  to three lines and should embody the gist of the article.
related_funcs:
  - put
  - related
  - function names
  - here
  - like
  - create_window
  - draw_rectangle
  - refresh_screen
  - etc.

---

Begin writing the article here. Note that this is just **markdown**. No need to do a <h1> or # as the template will generate this for you.

Additionally, this PR add some minor refactors and enhancements to looks, such as:

  • Improvements to overloaded methods:
    Improvements to overloaded methods
  • Improvements to guide category/tag pages
    Improvements to guides tag pages
  • Improvements to guides flow, adding automatic header and authorship details (with optional author website!)
    Improvements to guides article

Also fixes #11 (thanks @isdampe for reporting this!)

Still left as WIP:

  • Refactor contribution article on how to write guides using the middleman command

@alexcu
Copy link
Member Author

alexcu commented Oct 22, 2017

@jakerenzella It would be good to go through this with you so we can update how contributors (I'm thinking of #8, #10 and #9) can refactor their guides into the new format. Alternatively, we can merge these PRs first, and then merge in #12 and refactor these new guides into the new format.

@alexcu
Copy link
Member Author

alexcu commented Oct 22, 2017

@jakerenzella @macite Feedback on these changes (i.e., anything that may be now missing) would be great if you get a chance to have a look.

@jakerenzella
Copy link
Member

@alexcu Will review 👍

@alexcu alexcu merged commit 6079ab5 into splashkit:develop Jan 22, 2018
@alexcu
Copy link
Member Author

alexcu commented Jan 22, 2018

Now that this PR has been merged, @isdampe you may want to review the guides you published a while ago and see if you would like to update any authorship details in the new format 😊

As for #9 and #10, @AkshatBajaj and @drosborn you will need to update the PRs to reflect the new changes (just refer to the new guides for writing blog posts and ensure your post contents are consistent with them 😊). If you no longer want to contribute these blogs, you can close them or we can publish them on your behalf :)

@isdampe
Copy link
Contributor

isdampe commented Jan 22, 2018

Thanks for the heads up @alexcu I will check it out when I have some spare minutes :)

@AkshatBajaj
Copy link

Thanks @alexcu I will make changes in the guide.

@isdampe
Copy link
Contributor

isdampe commented Jan 27, 2018

I've taken a look this morning - the published guides I authored seem to still fit in well, in terms of context.

Good job on the updated contributing guide!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sticky sidebar overflows on mobile
4 participants