Skip to content

docs: fix broken references and improve contributor/developer guides#1467

Open
nooreldeenmansour wants to merge 4 commits intomainfrom
docs-polish
Open

docs: fix broken references and improve contributor/developer guides#1467
nooreldeenmansour wants to merge 4 commits intomainfrom
docs-polish

Conversation

@nooreldeenmansour
Copy link
Copy Markdown
Member

@nooreldeenmansour nooreldeenmansour commented Apr 16, 2026

This PR fixes multiple outdated flags/references, and introduces some improvements to the following documentation files:

  • CONTRIBUTING.md
  • testing.md
  • AGENTS.md

UDENG-9427

Comment thread CONTRIBUTING.md
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.94%. Comparing base (1f7d986) to head (c5ab8fe).
⚠️ Report is 2 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread CONTRIBUTING.md Outdated
Comment on lines 326 to 327
authd is licensed under the [GNU Lesser General Public License v3+](COPYING.LESSER).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I'll drop it. Since whoever is interested can easily find this information outside of this file

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done

Comment thread e2e-tests/testing.md
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):
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread CONTRIBUTING.md Outdated
Comment thread AGENTS.md Outdated
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".
Add extra flags for PAM module troubleshooting `--exec-debug` and
`--exec-log` as suggested by in #1468
Change the suggested socket path to `/tmp/authd.sock` instead of `/run/sock` as suggested in #1468
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants