uvacoder/webdev-glossary

A community-built glossary of technical terms.
See it live at www.glossary.dev.
Kindly refer to our Code Of Conduct here before contributing.

General Contributions

If you see that the glossary is missing a term, we would love your help in adding it!

How to Contribute Terms

New terms should be added to the content/terms directory as new markdown files, where the name of the markdown file is the term, lowercased and hyphenated. So a definition for "Command-Line Interface" would go in a file named command-line-interface.md. Examples should include the terms in a sentence, and be relevant and appropriate.

Follow this template for the structure of your new definition:

TEMPLATE:

---
title: "<Your Term Here>"
date: 2020-10-02
part-of-speech: <noun|verb|adjective>
synonyms: ["<Optional Synonyms>"]
abbreviation: <Optional Abbreviations or Acronyms>
---

Write out a definition of the term in markdown here.

## Example

> Use your definition in a sentence.

## Further Reading
- [Link Title](https://www.link.com)

For example, for the term Command-Line Interface the file path would be content/terms/command-line-interface.md and the contents might be:

---
title: "Command-Line Interface"
date: 2020-10-02
part-of-speech: noun
synonyms: ["Command Line"]
abbreviation: CLI
---

Refers to the text-input interface commonly used by developers to interact with computers and the services or processes running on them. A command-line interface accepts text input (commands) which execute processes and typically result in text output.

## Example

> System administrators use the command-line interface to SSH into virtual machines running in datacenters.

## Further Reading
- [Command-Line Interface on Wikipedia](https://en.wikipedia.org/wiki/Command-line_interface)

How to Submit a PR from Github Desktop

Go to content/terms and click the "Add File" button in the GitHub interface.

Name the file <your-new-term>.md for example if you were adding a definition for Command-Line Interface you would name the file command-line-interface.md.

Below the file, fill out the "Propose new file" inputs with information about the term you are adding.

Your title might be "Add definition for Command-Line Interface" and your extended description might be: "I didn't see this term defined so I added it, I linked to the wikipedia page because it is a pretty good overview of the concept."

Just share a bit about your reasoning for adding the content. Then click "Propose new file" to create a Pull Request.

Someone will follow up with questions on your PR if there is anything wrong or unclear, and then they'll approve it and merge it and it will go live on the site!

Contributing Code Improvements

We'd also love code contributions that beautify the site, make it more accessible and usable, and help it follow good web standards.

Local Development and Installation

The site is statically generated using the hugo framework. To run it locally follow these steps:

1. Fork the repo and clone it down to your local machine
2. Install hugo if you don't already have it installed.
3. Open a terminal in the root directory of the developer-glossary project and run hugo server -D
4. Check that no errors appear in the terminal, it should tell you it is running on localhost:1313. That means you can view the site running locally by going to http://localhost:1313 in your browser.

You're off to the races! Reference hugo docs to learn more and start making code contributions.

Syncing a Forked Repo

Sync a fork of a repository to keep it up-to-date with the upstream repository.

git remote add upstream https://github.com/do-community/developer-glossary.git
git fetch upstream
git checkout main
git merge upstream/main

Language Use Guidelines

All contributions made towards adding a new term and its definition must adhere to these common guidelines:

1. Every contribution made should adhere to the Code of Conduct
2. Avoid usage of country specific language when adding a new term, in the term definition and for the examples provided.
3. Use simple language. Avoid idioms and be clear.
4. Be accurate when providing definitions and examples for a term.
5. We also adhere to the official Github Community Guidelines which provides additional information on how to collaborate and contribute to projects hosted on Github.

Project Updates

You can follow updates on the development of our glossary, here.

• 10-30-20:

  • Added 3+ more terms to the glossary, and an action that performs a test to ensure the site build passes with each PR.
  • PRs are open for more terms! Let's build a glossary that helps our community to thrive.

• 10-28-20:

  • Issue being worked on by two contributors- still open to more help!
  • Merged 3+ new terms and glossary improvements. Remember to name your file using the lowercase and hyphenated convention.
  • Updated README to add more whitespace/styling elements.

• 10-26-20:

  • New Issue added for UI help- update our glossary's UI!
  • Merged 15+ new terms into the glossary, and fixed issue in file that prevented Hugo site from running.
  • Reviewed new and submitted terms for style/content, and submitted edits for various terms. Please follow the guidelines and be sure your terms/examples/links are helpful and appropriate.

• 10-19-20:

  • Merged 10+ new terms into the glossary