Giter VIP home page Giter VIP logo

glossary's Introduction

PEDANT: Pivotal Electronic Dictionary of Arcane Nomenclature and Terminology

We have all felt the frustration of not being able to fully participate in a conversation because of the large number of ACRONYMS (Alphabetic Characters Representing Obscure Names You Must Shorten) in use by GURUS (Groups Uttering Regrettably Unclear Slang) and long-term company VETERANS (Very Experienced Technical Experts Repeating ACRONYMS Nobody Speaks). Until you develop the EAR (Experience, Appreciation, and Respect) for a team's specific ARGOT (Abbreviated References to Generally Obvious Things), it's unfortunately easy to be left feeling like an IGNORAMUS (Individual Given No Opportunity to Respond to A Million Unintelligible Sayings).

This project aims to make Pivotal a more inclusive environment by explicitly defining the terms, acronyms, initialisms, abbreviations, and jargon used throughout our company.

Visit the glossary

https://cf-glossary.cfapps.io

Contributing entries

The site is generated from yaml files located in the /entries directory. An entry will look something like this:

---
headword: PWS
expansion: Pivotal Web Services
definition: >
  Pivotal's CF-as-a-service offering. This is an instance of 
  cf-deployment maintained by the CloudOps team. This environment
  is useful for getting feedback on the experience of operating 
  Cloud Foundry at scale.
links:
- https://run.pivotal.io
see_also:
- CF-D
- PaaS

Other than headword, all fields are considered optional.

These files can be created and edited manually. Or, to get started on a new entry, you can create an empty template by running rake add_word["Pair Programming"].

To preview how the site will look with new entries, build it with rake && open build/index.html

Acknowledgements

The need for this list became clear when two members of my team, both new Pivots, let me know how overwhelmed they felt by all the acronyms flying at them all the time. I don't think we would have had that conversation if not for the Inclusion workshop organized for us by Gareth Smith.

My humorous acronyming has been inspired by this delightful piece by Dan Caprera in McSweeny's Internet Tendency. Check it out.

Related Projects

Project Description
mikfreedman/pivotal-glossary-clients A collection of extensions for this glossary. webstore link
Manifaust/cloud-glossary Another Glossary project, hosted here: https://glossary.cfapps.io
motevets/pivotal-glossary Chrome extension that will expand acronyms based on this glossary. webstore link

glossary's People

Contributors

4n3w avatar alex-slynko avatar awmartin avatar bruce-ricard avatar cfryanr avatar dav1dc-pcf avatar deniseyu avatar jhamon avatar joshuatcasey avatar joshzarrabi avatar jspawar avatar kcboyle avatar mcwumbly avatar micahyoung avatar mikfreedman avatar mjj209 avatar parth-pandit avatar pivotal-mark-higuera avatar pivotaljohn avatar pivotalneil avatar professor avatar rosenhouse avatar scottcode avatar selshahawy avatar shanfan avatar skibum55 avatar slowestgirl avatar theckkw avatar timani avatar vmwghbot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

glossary's Issues

Potential to making it Pivotal Glossary

The website route suggests its a "cf glossary". Do we want to explore making it more inclusive by making it a Pivotal Glossary? Including the data folks, labs and other teams in the organization :)

Please configure GITBOT

Pivotal provides the Gitbot service to synchronize issues and pull requests made against public GitHub repos with Pivotal Tracker projects.

If you are a Pivotal employee, you can configure Gitbot to sync your GitHub repo to your Pivotal Tracker project with a pull request.

Steps:

  • Fork this repo: cfgitbot-config (an ask+cf@ ticket is the fastest way to get read access if you get a 404)
  • Add the Toolsmiths-Bots team to have admin access to your repo
  • Add the cf-gitbot ([email protected]) user to have owner access to your Pivotal Tracker project
  • Add your new repo and or project to config-production.yml file
  • Submit a PR, which will get auto-merged if you've done it right

If you are not a pivotal employee, you can request that [email protected] set up the integration for you.

You might also be interested in configuring GitHub's Service Hook for Tracker on your repo so you can link your commits to Tracker stories. You can do this yourself by following the directions at:

https://www.pivotaltracker.com/blog/guide-githubs-service-hook-tracker/

If you do not want to use Pivotal Tracker to manage this GitHub repo, Please add this repo to the Ignored repositories list

If there are any questions, please reach out to [email protected].

Cannot edit EOD "End of Day"

EOD is used for 2 different entries:
"End of Distribution" and "End of Day"
Clicking "Improve this entry" on either of these always redirects to the .yml for "End of Distribution"

Include tags for context

To address the issue of duplicate definitions in multiple contexts, and to allow folks to browse within a single context, I propose that definitions allow tags. Users could then view definitions with or without a given tag set.

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.