Skip to content

Commit

Permalink
update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
peterVG committed Jun 11, 2024
1 parent 6a14de4 commit 4aecbde
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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**: <my_new_term>
* **Revise**: <existing_term>
* **Delete**: <existing_term>
- 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.

Expand All @@ -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**: <my_new_term>
* **Revise**: <existing_term>
* **Delete**: <existing_term>
- 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
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.

0 comments on commit 4aecbde

Please sign in to comment.