Skip to content
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

Document how to vendor a repo #964

Merged
merged 7 commits into from
Dec 11, 2024

Conversation

hmpf
Copy link
Contributor

@hmpf hmpf commented Nov 27, 2024

No description provided.

@hmpf hmpf added the documentation Improvements or additions to documentation label Nov 27, 2024
@hmpf hmpf self-assigned this Nov 27, 2024
@codecov-commenter
Copy link

codecov-commenter commented Nov 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.59%. Comparing base (5a6b8c1) to head (84a4991).
Report is 43 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #964      +/-   ##
==========================================
+ Coverage   81.93%   82.59%   +0.65%     
==========================================
  Files         132      129       -3     
  Lines        4861     4808      -53     
==========================================
- Hits         3983     3971      -12     
+ Misses        878      837      -41     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@hmpf hmpf mentioned this pull request Nov 29, 2024
7 tasks
@hmpf hmpf marked this pull request as ready for review December 3, 2024 11:22
@hmpf hmpf force-pushed the document-how-to-vendor-a-repo branch from 77ca216 to 12e97ba Compare December 3, 2024 11:22
Copy link
Contributor

@podliashanyk podliashanyk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bunch of typos, another bunch of formatting issues, see below.

A suggestion for better readability: uppercase the GIVING and RECEIVING.
I would also suggest to replace the "giving-receiving" pair with f.e. "in-out" or "origin-target" for a better clarity IMO

docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
@hmpf
Copy link
Contributor Author

hmpf commented Dec 11, 2024

A suggestion for better readability: uppercase the GIVING and RECEIVING. I would also suggest to replace the "giving-receiving" pair with f.e. "in-out" or "origin-target" for a better clarity IMO

I went with ORIGIN and TARGET.

@lunkwill42 lunkwill42 self-requested a review December 11, 2024 07:50
Copy link
Member

@lunkwill42 lunkwill42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is definitely good to have a how-to for this, but even though this operation has been done once for argus and argus-htmx-frontend, it strikes me as a strange thing to have generic documentation for in Argus - it's not exactly documentation of Argus itself, or even some maintenance operation we can expect to be doing regularly for Argus.

I feel like this would more appropriately belong in some external knowledge base or wiki for our team.

docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
docs/development/howtos/vendor-a-repo.rst Outdated Show resolved Hide resolved
@hmpf
Copy link
Contributor Author

hmpf commented Dec 11, 2024

I feel like this would more appropriately belong in some external knowledge base or wiki for our team.

As long as it is public and I can find it when I need it. This is useful for more than our team.

Copy link
Contributor

@podliashanyk podliashanyk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See a comment below about heading levels

docs/development/howtos/vendor-a-repo.rst Show resolved Hide resolved
@hmpf hmpf requested a review from podliashanyk December 11, 2024 09:41
Copy link
Member

@lunkwill42 lunkwill42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work. Still not sure this really belongs in the Argus docs, though. Maybe we need our own tech blog? ;)

@hmpf hmpf merged commit f6f67e8 into Uninett:master Dec 11, 2024
14 checks passed
@hmpf hmpf deleted the document-how-to-vendor-a-repo branch December 11, 2024 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants