search

18F / 18f.gsa.gov

The 18F website
https://18f.gsa.gov
Other
293 stars 311 forks source link

Create a new area for whitepapers/howtos which are longer than blog posts. #297

Closed RobertLRead closed 9 years ago

RobertLRead commented 10 years ago

This came out of a discussion about what to do with a longer article which Eric and I have written that will be incongruous with our typical blog length. I think this should take like an hour to do.

konklone commented 10 years ago

So this might be like a /guides or /publications or /whitepapers page, starting out with our 'bare' template.

Though it'd be nice to put the guides in a data/guides.yml file, which is then used to generate the page and also an accompanying RSS feed.

meiqimichelle commented 10 years ago

One thought: we will likely have a /best-practices or /styleguides section. Recommend that the home for these longer papers take a different name. /treatises ? ;) Unless you're thinking what you wrote is a best practice sort of guide.

quepol commented 10 years ago

Can we MVP this idea by just creating a blog tag? That way they could be collected at 18f.gsa.gov/tags/treatises ? I really want to avoid page/section creep with the site, especially when tagging them accomplishes the same thing.

konklone commented 10 years ago

That's fine by me. (maybe something other than "treatises" ;)) So we would proceed with the Using More Open Source piece as a blog post, then? We can pick it back up on email where we left off.

RobertLRead commented 10 years ago

I hope you guys are joshing with me---"treatise", indeed!

To me one of the most important categories of publications is the "howto". I would much rather have /howto. However, I personally would rather show off an impressive body of documents, with sections for "How Tos", "Style Guides", and "Best Practices", since I don't think at first we will have enough for each category to warrant an entire page.

On Wed, Oct 8, 2014 at 5:51 PM, Hillary Hartley notifications@github.com wrote:

Can we MVP this idea by just creating a blog tag? That way they could be collected at 18f.gsa.gov/tags/treatises ?

— Reply to this email directly or view it on GitHub https://github.com/18F/18f.gsa.gov/issues/297#issuecomment-58433762.

Robert L. Read, PhD Co-Founder, 18F (202) 809-1941

janearc commented 10 years ago

Missives? Soliloquies?

mobile emails are (possibly) sloppy & terse. sorry.

On Oct 8, 2014, at 17:59, Robert L. Read notifications@github.com wrote:

I hope you guys are joshing with me---"treatise", indeed!

To me one of the most important categories of publications is the "howto". I would much rather have /howto. However, I personally would rather show off an impressive body of documents, with sections for "How Tos", "Style Guides", and "Best Practices", since I don't think at first we will have enough for each category to warrant an entire page.

On Wed, Oct 8, 2014 at 5:51 PM, Hillary Hartley notifications@github.com wrote:

Can we MVP this idea by just creating a blog tag? That way they could be collected at 18f.gsa.gov/tags/treatises ?

— Reply to this email directly or view it on GitHub https://github.com/18F/18f.gsa.gov/issues/297#issuecomment-58433762.

Robert L. Read, PhD Co-Founder, 18F (202) 809-1941 — Reply to this email directly or view it on GitHub.

RobertLRead commented 10 years ago

Soliloquies is good. Screeds?

On Wed, Oct 8, 2014 at 7:14 PM, Jane Avriette notifications@github.com wrote:

Missives? Soliloquies?

mobile emails are (possibly) sloppy & terse. sorry.

On Oct 8, 2014, at 17:59, Robert L. Read notifications@github.com wrote:

I hope you guys are joshing with me---"treatise", indeed!

To me one of the most important categories of publications is the "howto". I would much rather have /howto. However, I personally would rather show off an impressive body of documents, with sections for "How Tos", "Style Guides", and "Best Practices", since I don't think at first we will have enough for each category to warrant an entire page.

On Wed, Oct 8, 2014 at 5:51 PM, Hillary Hartley < notifications@github.com> wrote:

Can we MVP this idea by just creating a blog tag? That way they could be collected at 18f.gsa.gov/tags/treatises ?

— Reply to this email directly or view it on GitHub https://github.com/18F/18f.gsa.gov/issues/297#issuecomment-58433762.

Robert L. Read, PhD Co-Founder, 18F (202) 809-1941 — Reply to this email directly or view it on GitHub.

— Reply to this email directly or view it on GitHub https://github.com/18F/18f.gsa.gov/issues/297#issuecomment-58442768.

Robert L. Read, PhD Co-Founder, 18F (202) 809-1941

gboone commented 10 years ago

This is great, and with a tag on the blog we can get started right away. If we need to build it out further in the future this is a perfect use for Jekyll's collections feature.

RobertLRead commented 10 years ago

I created a "long article" label, to avoid having to make a distinction at present between styleguide, best practice, howto, missive, soliloquy, rant and screed. But that should let Greg do his part. I will now go label the ones that I think deserve it.

On Wed, Oct 8, 2014 at 9:19 PM, Greg Boone notifications@github.com wrote:

This is great, and with a tag on the blog we can get started right away. If we need to build it out further in the future this is a perfect use for Jekyll's collections feature http://jekyllrb.com/docs/collections/.

— Reply to this email directly or view it on GitHub https://github.com/18F/18f.gsa.gov/issues/297#issuecomment-58451759.

Robert L. Read, PhD Co-Founder, 18F (202) 809-1941

quepol commented 10 years ago

How do people feel about the tag "longread" -- it's common online these days: https://twitter.com/hashtag/longread

gbinal commented 10 years ago

For a tag, sure. And I agree with starting with a tag of sorts.

I think a /something page* would be warranted when we have generated 3-4 items to warrant it.

G

gbinal commented 10 years ago

For a tag, sure. And I agree with starting with a tag of sorts.

I think a /something page* would be warranted when we have generated 3-4 items to warrant it.

G

*though not actually /treatise ;)

gboone commented 10 years ago

I am pro longread. Though screed could have it's own place and time.

konklone commented 10 years ago

longread works.

screed

konklone commented 9 years ago

So we ended up publishing Rob's post, tagged with longread. I think that's good enough.

RobertLRead commented 9 years ago

Dude, it is your post as well.

And, what makes you think that aren't more long posts coming?

Personally, I don't really care, because I don't mind long things mixed in with the short thing...but just sayin'.

On Wed, Nov 26, 2014 at 7:59 PM, Eric Mill notifications@github.com wrote:

So we ended up publishing Rob's post, tagged with longread. I think that's good enough.

— Reply to this email directly or view it on GitHub https://github.com/18F/18f.gsa.gov/issues/297#issuecomment-64732133.

Robert L. Read, PhD Managing Director, 18F Consulting http://18f.github.io/consulting/ (202) 809-1941

konklone commented 9 years ago

@RobertLRead Sorry, I've been whizzing through tickets and typing fast. I do consider you its primary author and godfather, though. :smiley:

I hope more long posts are coming! I meant that we solved it through a tag, and I don't think we need to evaluate an alternative approach unless we hit a pain point. Anyone who disagrees with an alternative course should totally re-open the ticket.