Skip to content

Commit 019638e

Browse files
Add a reference this content section (#78)
* Adding a reference section with bibtex Signed-off-by: Samuel Tauil <[email protected]> * Adding Refence Materials page base format Signed-off-by: Samuel Tauil <[email protected]> * Title change Signed-off-by: Samuel Tauil <[email protected]> * Add authors and fix bibtex reference Signed-off-by: Samuel Tauil <[email protected]> * Direct link fix to the 1.1.0 release Signed-off-by: Samuel Tauil <[email protected]> * Release version disclaimer fix Signed-off-by: Samuel Tauil <[email protected]> * Move REFERENCES to project repo Signed-off-by: Samuel Tauil <[email protected]> * Update README.md Co-authored-by: Scott Rigby <[email protected]> Signed-off-by: Samuel Tauil <[email protected]> * remove gh code suggestion glitch Signed-off-by: Scott Rigby <[email protected]> * Deleting manual authors.md in favor of generated file in #82 See #82 Signed-off-by: Scott Rigby <[email protected]> --------- Signed-off-by: Samuel Tauil <[email protected]> Signed-off-by: Scott Rigby <[email protected]> Co-authored-by: Scott Rigby <[email protected]>
1 parent a6a7d83 commit 019638e

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

+25
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,28 @@ For more information about the OpenGitOps project, see: <https://github.com/open
2323
## Code of Conduct
2424

2525
The OpenGitOps community follows the [CNCF Code of Conduct](https://github.com/open-gitops/.github/blob/main/CODE_OF_CONDUCT.md).
26+
27+
## Reference this Content
28+
29+
Below is a [BibTex](https://www.bibtex.org) code snippet to use as reference for the content available in this repository. There is one required change, and several optional adjustments you may make to the snippet.
30+
31+
Required:
32+
- at minimum you will need to change the `Accessed` date (when you accessed this material) in the [note](https://www.bibtex.com/f/note-field/) field.
33+
34+
Optional: You may choose to reference a different release version. If so:
35+
- Change the `Release version` in the [note](https://www.bibtex.com/f/note-field/) field.
36+
- Update the [year](https://www.bibtex.com/f/year-field/) field to match. See list of releases by date [here](https://github.com/open-gitops/documents/releases).
37+
- Update the file link in `Authors` in the [note](https://www.bibtex.com/f/note-field/) field. You may find the list of authors by your chosen release version in the [reference](https://github.com/open-gitops/documents/blob/main/reference/) directory in this Git repo.
38+
39+
Optional: You may reference multiple versions in the same article. If so:
40+
- Update the [CiteKey](https://www.bibtex.com/g/bibtex-format/#citekey) below ("GitOps-Principles-and-Glossary") so each is unique (for example, append the version "-v1.0.0").
41+
- ⚠️ Note that the GitOps Principles and Glossary are versioned together, so when citing an individual principle and glossary item, ensure the versions match. This is because the two files have hyperlinks from one to the other that may be incorrect or broken between different versions.
42+
43+
```
44+
@misc{GitOps-Principles-and-Glossary,
45+
title = {{GitOps Principles and Glossary}},
46+
howpublished = {\url{https://github.com/open-gitops/documents}},
47+
note = {Accessed: YYYY-MM-DD. Release version: 1.0.0. Authors: \url{https://github.com/open-gitops/documents/blob/main/reference/authors-v1.0.0.md}.},
48+
year = {2021}
49+
}
50+
```

0 commit comments

Comments
 (0)