Skip to content

Update job writing guide docs #718

Open
mtuchi wants to merge 8 commits intomainfrom
714-job-writing
Open

Update job writing guide docs #718
mtuchi wants to merge 8 commits intomainfrom
714-job-writing

Conversation

@mtuchi
Copy link
Copy Markdown
Contributor

@mtuchi mtuchi commented Nov 12, 2025

Short Description

Improve job writing guide docs by grouping into smaller topics and add warning message on Referencing credentials in job code section. [See advanced concept page]

Closes #714

Details

  • Group job writing guide content into specific topic files and update sidebar
  • Add a warning about Referencing credential secretes in job code

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to
know!):

  • Code generation (copilot but not intellisense)
  • Learning or fact checking
  • Strategy / design
  • Optimisation / refactoring
  • Translation / spellchecking / doc gen
  • Other
  • I have not used AI

You can read more details in our
Responsible AI Policy

@mtuchi mtuchi linked an issue Nov 12, 2025 that may be closed by this pull request
2 tasks
@mtuchi
Copy link
Copy Markdown
Contributor Author

mtuchi commented Nov 12, 2025

Hey @hunterachieng Please review my pr and share your feedback, See my quick walk through video here

Copy link
Copy Markdown
Collaborator

@josephjclark josephjclark left a comment

Choose a reason for hiding this comment

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

This PR confused me a bit until I figured out what you were doing!

Generally I approve, I think it's great. Just a couple of suggestions before I'm ready to merge

Comment thread docs/jobs/advanced-concepts.md Outdated
Comment thread docs/jobs/advanced-concepts.md Outdated
Comment thread docs/jobs/advanced-concepts.md Outdated
Comment thread docs/jobs/advanced-concepts.md Outdated
@mtuchi mtuchi requested a review from josephjclark May 4, 2026 14:11
@josephjclark
Copy link
Copy Markdown
Collaborator

You know what @mtuchi, I just was just taking a final look over this and the menu is now like this:

Write Jobs
  - Job Writing Guide
  - Security Considerations

It's a bit strange to have just two submenus, and "Write Jobs" and "Job Writing Guide" are basically the same

So! What if we remove Job Writing Guide and re-parent each section under Write Jobs? That's way cleaner, and the Security page becomes just another section of the guide.

@mtuchi
Copy link
Copy Markdown
Contributor Author

mtuchi commented May 5, 2026

It's a bit strange to have just two submenus, and "Write Jobs" and "Job Writing Guide" are basically the same

So! What if we remove Job Writing Guide and re-parent each section under Write Jobs? That's way cleaner, and the Security page becomes just another section of the guide.

Yeah totally agree @josephjclark , let me do that

@mtuchi
Copy link
Copy Markdown
Contributor Author

mtuchi commented May 5, 2026

@josephjclark
I have added all job writing sections under Write Jobs category

job-write.mp4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Update job writing docs

3 participants