docs: fix broken references and improve contributor/developer guides#1467
docs: fix broken references and improve contributor/developer guides#1467nooreldeenmansour wants to merge 4 commits intomainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1467 +/- ##
=======================================
Coverage 86.94% 86.94%
=======================================
Files 93 93
Lines 6366 6366
Branches 111 111
=======================================
Hits 5535 5535
Misses 775 775
Partials 56 56 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| authd is licensed under the [GNU Lesser General Public License v3+](COPYING.LESSER). | ||
|
|
There was a problem hiding this comment.
We have two licenses, GPL-3 (COPYING) and LGPL3 (COPYING.LESSER). Not sure if we should mention that in the CONTRIBUTING.md though. Maybe just drop it.
There was a problem hiding this comment.
I'll drop it. Since whoever is interested can easily find this information outside of this file
7cdcf6d to
c82e68e
Compare
| The tests need a VM to run. This can be easily setup by using the domain definition and cloud-init configuration provided in the repository. | ||
|
|
||
| 1. Download the latest Ubuntu Desktop image (and resize it): | ||
| 1. Download the Ubuntu cloud image for the target release (and resize it): |
There was a problem hiding this comment.
We definitely need to do another run at writing this documentation for the e2e tests, since they changed a lot after this was first written
There was a problem hiding this comment.
I wonder if it's worth the effort to keep the manual steps up-to-date since we have the script which does the provisioning automatically.
c82e68e to
263785a
Compare
d8c1c45 to
659d39f
Compare
b36d367 to
c708d82
Compare
The `pam_binary_exec` build tag was refrenced, and it is non-existent
- Fix ToC anchors and heading capitalisation - Replace hardcoded commit-SHA link to the deleted `integration_test.go` with an evergreen link to `cli_test.go` on main.
…g.md` Introduce a `RELEASE` variable in the download step so the image URL, image filename, and cloud-init template path all derive from it rather than being hardcoded to questing. Fix the snapshot revert command, which referenced a non-existent name "fresh-install" instead of the name used at creation time, "initial-setup".
c708d82 to
c5ab8fe
Compare
This PR fixes multiple outdated flags/references, and introduces some improvements to the following documentation files:
CONTRIBUTING.mdtesting.mdAGENTS.mdUDENG-9427