From 4aecbde6e64811e5397893d2a5d3f0fd72939448 Mon Sep 17 00:00:00 2001 From: Peter Van Garderen Date: Tue, 11 Jun 2024 10:53:02 -0700 Subject: [PATCH] update instructions --- README.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 60bf1d0..b36db07 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,18 @@ ## [Read](glossary.md) the glossary +## [Revise](https://github.com/orcfax/glossary/issues) the glossary +- Authorized users can **create** new terms as well as **update**, and **delete** existing ones. +- All terms have their own .md file in the /terms directory +- To propose an update to the glossary open a [new Issue](https://github.com/orcfax/glossary/issues) in the Glossary repo and reference the correct term.md file using the following pattern: + * **New**: + * **Revise**: + * **Delete**: +- Provide a link to the term.md file as the first and only comment in the issue. +- Add comments to the thread as needed. +- Submit a [Pull Request](https://github.com/orcfax/glossary/pulls) to commit a new term .md file or commit revisions to the contents of an existing term.md file. +- The glossary product owner will review and approve PRs based on the comments and decisions made in the comment threads. + + ## About the glossary This [glossary](glossary.md) contains terms and definitions for the entities and concepts in the Orcfax domain. @@ -10,15 +23,4 @@ Orcfax is an oracle software system that publishes data about real-world events This glossary is [reference](https://diataxis.fr/reference/) documentation that is intended to guide Orcfax design and development. That means the glossary terms must be comprehensive, unambigous, as well as semantically and logically consistent with all other terms in the glossary. -The Orcfax docs site contains more detailed [explainer](https://docs.orcfax.io) documentation that is better meant for stakeholders to understand Orcfax concepts and objectives. - -## [Revise](https://github.com/orcfax/glossary/issues) the glossary -- Authorized users can **create** new terms as well as **update**, and **delete** existing ones. -- All terms have their own .md file in the /terms directory -- To propose a revision open a [new Issue](https://github.com/orcfax/glossary/issues) in the Glossary repo and reference the correct term.md file using the following pattern: - * **New**: - * **Revise**: - * **Delete**: -- Provide a link to the term.md file as the first and only comment in the issue -- Add comments to the thread as needed -- If a decision is made to create, revise or delete a term then submit a [Pull Request](https://github.com/orcfax/glossary/pulls) to commit a new term .md file or commit revisions to the contents of an existing term.md file \ No newline at end of file +The Orcfax docs site contains more detailed [explainer](https://docs.orcfax.io) documentation that is better meant for stakeholders to understand Orcfax concepts and objectives. \ No newline at end of file