-
Notifications
You must be signed in to change notification settings - Fork 51
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a reference this content section #78
Conversation
Signed-off-by: Samuel Tauil <[email protected]>
Signed-off-by: Samuel Tauil <[email protected]>
I have also added a reference material page which includes various types of content related to GitOps to be tracked. |
Signed-off-by: Samuel Tauil <[email protected]>
Title changed with the commit 2bdf213 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Afar from that one nitpick: This looks incredibly good! Thanks a lot Samuel!
Signed-off-by: Samuel Tauil <[email protected]>
README.md
Outdated
|
||
## Reference this Content | ||
|
||
A [BibTex](https://www.bibtex.org) code snippet to use as reference for the content available in this repository is listed below, make sure to change your site visit date accordinly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in keeping with below
A [BibTex](https://www.bibtex.org) code snippet to use as reference for the content available in this repository is listed below, make sure to change your site visit date accordinly. | |
A [BibTex](https://www.bibtex.org) code snippet to use as reference for the content available in this repository is listed below, make sure to change your site visit date, and optionally release version and year, accordingly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed with 747bfc5
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just checking, you didn't want to add "and year"? For example, referencing v1.0.0 the year
would be 2021, and v1.1.0 (assuming we get #76 out this year) would be 2024.
Maybe that would be better as a new sentence for more clarity anyway. How about something like this?
Make sure to update the
year
to match the release version you're referencing. See the list of releases by date here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is referring to the date a person creating the research paper visit the repo and noted it as a reference on his/her bibtex bibliographical database and not the date of the release of the content. Usually link references in articles carry a date of visit in the references section at the end of the article.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We just chatted on Slack, this was indeed a misunderstanding. I can see how you thought I was referring to the YYYY
, but in fact I meant the year field. So here's a slightly updated proposed addition (adding "year field" to be clear):
If you reference a different release version, make sure to also update the
year
field accordingly. See the list of releases by date here.
Signed-off-by: Samuel Tauil <[email protected]>
Signed-off-by: Samuel Tauil <[email protected]>
Signed-off-by: Samuel Tauil <[email protected]>
@scottrigby I removed the REFERENCES.md file from documents repo and will add it to projects repo |
Co-authored-by: Scott Rigby <[email protected]> Signed-off-by: Samuel Tauil <[email protected]>
Signed-off-by: Scott Rigby <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for all the work and collaboration 👍
See open-gitops#82 Signed-off-by: Scott Rigby <[email protected]>
We just need to wait for #82 to merge so the generated author file for v1.0.0 exists that we're referencing in the Bibtex snippet here. |
Added a bibtex snippet to be used when refferring to the content specialy to principles and glossary.
Signed-off-by: Samuel Tauil [email protected]