Skip to content
This repository has been archived by the owner on Feb 24, 2021. It is now read-only.

Glossary document #201

Open
KarolKaczmarek opened this issue Sep 28, 2016 · 2 comments
Open

Glossary document #201

KarolKaczmarek opened this issue Sep 28, 2016 · 2 comments
Labels
discussion The issue is a discussion. enhancement The issue is an enhancement request.

Comments

@KarolKaczmarek
Copy link
Contributor

As mentioned in #199.
I think it would be useful if we had some kind of glossary where we would explain most common terms/abbreviations we use in DscResources area. This way people new to it could quickly get familiar with those and better understand what we are talking about in issues/PRs.

@KarolKaczmarek KarolKaczmarek added enhancement The issue is an enhancement request. discussion The issue is a discussion. labels Sep 28, 2016
@johlju
Copy link
Contributor

johlju commented Apr 17, 2018

Anyone have suggestion where we can put a glossary? Are there any existing we can link to?

When linking to documentation from other sources such glossary most likely will be missed. Maybe all documentation should have a footnote linking to a GLOSSARY.md (or an existing glossary). If the glossary is in this repo then to keep the glossary from being outdated it would be a need to be enforced to update it in PR's.

@johlju
Copy link
Contributor

johlju commented May 30, 2018

Let's add that when we do issue #202.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
discussion The issue is a discussion. enhancement The issue is an enhancement request.
Projects
None yet
Development

No branches or pull requests

2 participants