Giter Club home page Giter Club logo

rfcs's Introduction

Stratic RFCs repository

By its very nature, Stratic is a project broken up into many repositories. Because of this, it's difficult to track things that apply to the entire project.

This repository is designed to fill that gap. It provides a place to discuss the evolution of the project's design, as well as a place to track project-wide issues that haven't yet been turned into concrete proposals.

Contributing

Everyone should feel free to add new things to the issue tracker. This is great for:

  1. Discussing features we should figure out how to do in the Stratic model
  2. Highlighting pain points we should try to improve
  3. Anything else that would require changes across multiple modules

Stratic is (among other things) about doing design the Right Way™. That means that any feedback, positive or negative, is really important. The more diverse the people and viewpoints, the better the project will be.

If you have a more concrete proposal, you could also send a Pull Request.

License

Creative Commons Attribution ShareAlike 4.0

Maintainer

AJ Jordan [email protected]

rfcs's People

Contributors

strugee avatar

Stargazers

 avatar

Watchers

 avatar  avatar

rfcs's Issues

Document #stratic

#stratic on Freenode is a thing now; we should document the hell out of it.

Logo

Maybe the JS logo's yellow background with a | character and a file? I really don't know. I also like how "Stratic" kinda sounds like "stratosphere", but...

Post cutoffs

We need some way to do "read more" links in posts.

Explore decoupling index types

I wonder if there's something we can do to decouple the concept of an index type from consuming modules. Right now everything has to obey the contract imposed by stratic-posts-to-index, but maybe that should change.

Switch to `file.data`

Deprecating stratic-parse-header in favor of YAML frontmatter made it clear that the current "attach properties directly to the file" approach is a serious composability problem. The consumer should be able to drop in pretty standard Node modules for the parsing step and with the custom properties, they can't.

This might also simplify post.jade, but I'm not sure. I think gulp-attach-to-template will probably stick around, which means that this won't help. But maybe not.

Moved from straticjs/generator-stratic#4.

Default categories

On my personal blog I would like a way to specify some default categories and have posts automatically included in those categories unless I specify otherwise.

Index truncation

Need a way to truncate indexes. Mostly useful for the RSS support.

This would probably function similarly to stratic-paginate-indexes internally.

Release 1.0

Stratic is getting mature enough that it's time to start pushing towards a 1.0 release. Here's what I think we have to do before that can happen.

General:

  • Decide on a logo, #22
  • Move to gulp 4, #34
  • Policy on pulling modules into the straticjs org, #21

Website:

Documentation:

Miscellaneous cleanups:

  • I don't go by Alex anymore so make sure everything says AJ, #31
  • Make sure package.json repository metadata is correct, #32
  • Ensure READMEs don't reference Stratic header parsing, #25
  • Consistently use PluginErrors everywhere, #23
  • Support NODE_DEBUG, #4

We may want to do #14 too, before we get too many users? We might want to do straticjs/generator-stratic#16 and straticjs/generator-stratic#15 too, I'm not sure.

Make clean-URL story consistent

Some parts of the system like e.g. stratic-indexes-to-rss create and assume clean URLs without extensions. I should go through all the modules and make sure that they handle URLs consistently.

Drafts

We need to support drafts.

Author metadata attacher

I'm thinking it would be nice to have a module that would attach additional metadata to the Vinyl file based on the author. Things like the author's URL, etc. This would be particularly useful on blogs where multiple people are authoring content.

"Decorator" utility module for indexes

There's a bunch of useful stuff you might want on indexes, like the English-language month name, or the number in permalinks (which may have to have a 0 appended to it), etc. Currently all this is just done inline in templates, but it'd probably be good to push this out into a reusable module everyone can share.

Offset not taken into account

Turns out we need to do a better job taking the UTC offset into account. See strugee/strugee.github.com#40.

Things that need to be fixed:

  • stratic-date-in-path
  • stratic-posts-to-index
  • stratic-indexes-to-rss
  • #18, because this is getting complex enough that that's just a requirement now
  • generator-stratic Pug

Themes

Jekyll has a notion of "themes", which are reusable cross-project. Maybe we should too?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.