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

Document new features #1072

Closed
benbalter opened this Issue May 10, 2013 · 23 comments

Comments

Projects
None yet
6 participants
@benbalter
Contributor

benbalter commented May 10, 2013

Maybe I'm just having trouble finding them... but there's not a lot of documentation around some of 1.0's new features. Specifically:

  • Support for the Gist tag for easily embedding Gists (example)
  • Automatically generated post excerpts (example)
  • Save and preview drafts before publishing (example)
  • brew doctor and relative_permalinks (see #1081, #1077)

Would be awesome to be able to link to something to get new users up to speed.

@zachgersh

This comment has been minimized.

Contributor

zachgersh commented May 10, 2013

Do we need something like a "What's new in 1.0" page? Or is this more like a quickstart.

@parkr

This comment has been minimized.

Member

parkr commented May 10, 2013

So here's what I want to do:

  • Move docs to pages
  • Write about releases as posts, like a proper blog
@benbalter

This comment has been minimized.

Contributor

benbalter commented May 10, 2013

👍

@zachgersh

This comment has been minimized.

Contributor

zachgersh commented May 10, 2013

This will make putting the RSS together a lot easier. Can you merge @benbalter Docs change then so I can refactor my RSS bit?

@benbalter

This comment has been minimized.

Contributor

benbalter commented May 10, 2013

If it helps, here's my RSS feed.

@zachgersh

This comment has been minimized.

Contributor

zachgersh commented May 10, 2013

Thanks @benbalter! I was 100% going to use jekyll to fill out the RSS feed and your example is perfect.

@parkr

This comment has been minimized.

Member

parkr commented May 10, 2013

I'd love to have a /releases.atom with specialized data (maybe like rubygems.org?) and a normal feed for the blog posts.

@zachgersh

This comment has been minimized.

Contributor

zachgersh commented May 10, 2013

so, you are saying we'd have two types of posts, one for releases and one for just general types of jekyll related stuff i.e. look at this cool plugin?

@parkr

This comment has been minimized.

Member

parkr commented May 10, 2013

I guess if blog posts are just about releases then it's a good idea. Just to be safe, filter site.posts for a release category.

@zachgersh

This comment has been minimized.

Contributor

zachgersh commented May 10, 2013

will do.

@zachgersh

This comment has been minimized.

Contributor

zachgersh commented May 10, 2013

So, I was thinking that history would actually generate a release post but it seems like you want a history + a set of release posts. I am assuming the release posts actually go into more detail about some of the items that were added to the current release.

Seems like the jekyll "blog" about releases should be a top nav item and be styled differently?

@zachgersh

This comment has been minimized.

Contributor

zachgersh commented May 10, 2013

@cobyism get in here as well :)

@skopp

This comment has been minimized.

skopp commented May 10, 2013

Have you looked at Prose.io or RTD, or similar services/apps? Suggesting them, just in case...

@parkr

This comment has been minimized.

Member

parkr commented May 11, 2013

Any of you guys want to take a crack at this? I gotta head to bed :)

@benbalter

This comment has been minimized.

Contributor

benbalter commented May 11, 2013

Updated Issue body with links to some example gists which may prove a good start.

@zachgersh

This comment has been minimized.

Contributor

zachgersh commented May 12, 2013

I am going to :)

On May 11, 2013, at 4:42 PM, Parker Moore notifications@github.com wrote:

Any of you guys want to take a crack at this? I gotta head to bed :)


Reply to this email directly or view it on GitHub.

@zachgersh

This comment has been minimized.

Contributor

zachgersh commented May 12, 2013

Thanks @benbalter great start with the gists. I am actually thinking this a great first post for what @parkr had talked about. I will throw one together and maybe you want to review it

@cobyism We need to discuss another section addition!

@zachgersh

This comment has been minimized.

Contributor

zachgersh commented May 12, 2013

So, i got a start on this as well. Tell me if my thinking was correct:

  1. New spot in the nav called posts (or blog)
  2. Posts has a slightly different layout then other sections (no docs side bar nav)
  3. Posts index features an excerpt of the notes for each release
  4. You click to read the full release notes
  5. RSS feed will be generated for this release notes section much the same way @benbalter has generated his RSS

That's the idea I was working through. If it sounds dumb let me know.

@parkr

This comment has been minimized.

Member

parkr commented May 12, 2013

  1. I'd probably call it Blog, Blag or Releases

Sounds great!

@cobyism

This comment has been minimized.

Member

cobyism commented May 12, 2013

I'd probably call it…

Calling it a "blog" and having it primarily contain release information sounds a bit odd, but by the same token calling the section "releases" and maybe having the odd thing in there that’s got nothing to do with a release could be misleading too.

How about calling it "News"? I think that’s a fairly flexible term for what the section would be—i.e. updates about releases that happen and the changes they contain, as well as being flexible enough to possibly contain other project-related news and announcements in there too.

@parkr

This comment has been minimized.

Member

parkr commented May 12, 2013

News sounds great! I'm already nearly done with it.

@parkr

This comment has been minimized.

Member

parkr commented Jul 9, 2013

Save and preview drafts before publishing

@benbalter "Working with drafts" page, perhaps? Right now it's only on the "Upgrading" page.

@parkr

This comment has been minimized.

Member

parkr commented Jul 9, 2013

Save and preview drafts before publishing

#1289.

@parkr parkr closed this Jul 12, 2013

@jekyll jekyll locked and limited conversation to collaborators Feb 27, 2017

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.