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

Create glossaries for general terminology and to name the components. #17

Merged
merged 7 commits into from
Mar 17, 2015

Conversation

smashwilson
Copy link
Member

It's confusing to be using different words for the same things. Let's agree on a common lexicon.

This is my proposal for what we should call various things. If you disagree, please comment on the request so we can agree on better names! Once I click that tempting green merge button, anyone who talks about the "renderer" or the "pipeline" has to buy me a coke.

I've also taken a stab at assigning responsibilities to different parts of the system based on my current understanding of what we're trying to build. I've left some things intentionally vague, like where layouts are managed, because I don't have a clear vision yet of where that should be done (:point_right: to #6 if you have thoughts to contribute there specifically). If I'm wildly off about any of the things I did nail down, this would also be a good place to talk about that.

/cc @rgbkrk @kenperkins @steveortiz

paths
Subpath within the final presented content of a deconst site. Includes the fully-qualified
domain name of the page. For example:
``developer.rackspace.com/sdks/cloud-servers/getting-started/``.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm abusing the word "path" here a little, since we have to include the domain as well. We could call them "presentation IDs" or something instead, but that seems silly.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit confused, is the path just /sdks/cloud-servers/gettingstarted or must it include the domain?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because we need to support multiple domains, we need to include the domain. It needs to be unique across the deconst-managed web presence, so that we can map it unambiguously.

I realize this doesn't really make it a "path" any more, but I couldn't think of what a better name should be, without being so generic as to be meaningless.

``https://github.com/deconst/deconst-docs/tree/glossary/running/architecture``.
* A specific post in a Jekyll blog, generated from (theoretical) content at
``https://github.com/rackerlabs/developer-blog/_posts/mongodb-3.0-getting-started.md``:
``https://github.com/rackerlabs/developer-blog/blog/mongodb-3.0-getting-started``.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kenperkins Is this any better? I'm struggling trying to communicate this one for some reason.

@kenperkins
Copy link
Contributor

That looks a bit more explicit. 👍

@smashwilson
Copy link
Member Author

Okay, great.

Finding a more appropriate name for "path" is the only concern left, then.

@smashwilson
Copy link
Member Author

@kenperkins, @rgbkrk, @steveortiz: I've added a diagram for our initial architecture, including only components that we should work on for the first milestone.

Let me know what you think, have giant flame-wars amongst yourselves, etc.

@kenperkins
Copy link
Contributor

lgtm.

@rgbkrk
Copy link
Member

rgbkrk commented Mar 17, 2015

Nice diagram.

@smashwilson
Copy link
Member Author

Concurrence: reached 🏁

smashwilson added a commit that referenced this pull request Mar 17, 2015
Create glossaries for general terminology and to name the components.
@smashwilson smashwilson merged commit 15fd23c into deconst:master Mar 17, 2015
@smashwilson smashwilson deleted the glossary branch March 17, 2015 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants