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

Add a basic glossary outline #369

Merged
merged 1 commit into from
Mar 15, 2016
Merged

Conversation

drapergeek
Copy link
Contributor

This starts the basic of a glossary in the repo. This is something we've talked about a bit while moving forward in development and I wanted to get a structure started so that we could start adding to it.

Some of this information is already in the Wiki so you're probably asking yourself "Why would we move this into the repo?" I'm glad you asked!

  1. Moving it into the repo allows it to be versioned alongside the code. As the code changes and new ideas and concepts are added and removed, this file can change with the code. It may fall out of date at periods, that inevitable but if properly maintained, you can look back at a previous release and understand the concepts that are particular to that release that may have changed in a newer release.
  2. Wikis do not have any way of reviewing feedback. If I have something I'd like to add to the Wiki and I add it, it may be 100% wrong and no one realizes that. Moving this to the repo allows me to get feedback before it's merged.
  3. Wikis do not allow external contributions (at least not that I'm aware of). I'd like to be able to update this without having access to the repo. That's not possible with a Wiki. Moving this also makes it easy for the community to get involved with updating it.

I haven't filled in much as my understanding is still kind of vague but I wanted something to start adding PRs against.

@@ -0,0 +1,22 @@
# Cog Glossary

## Bundle
Copy link
Contributor

Choose a reason for hiding this comment

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

Bundle - a package containing one or more commands and the attributes (rules, permissions, possible options, documentation, templates, etc.) that belong to each command. A standard bundle can contain all the code for the command execution. It is possible for a bundle to only contain a configuration file that simply references an existing script - referred to as "simple bundles". https://github.com/operable/cog/wiki/Commands-and-Bundles#bundles

kevsmith pushed a commit that referenced this pull request Mar 15, 2016
@kevsmith kevsmith merged commit 01f304c into operable:master Mar 15, 2016
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.

5 participants