Reorganize documentation with audience-driven navigation#68
Merged
Conversation
- Rename getting-started/ to tutorials/ (tutorial content only) - Create concepts/ with architecture and feature-flags (conceptual content) - Move development-workflow and testing-and-debugging to guides/ - Move compatibility.md to reference/ - Rename SampleScripts/ to samples/ with per-sample directories - Separate templates/ to top-level directory - Create quick-start/ directory for upcoming quick-start guides
- Rewrite root README.md as audience-driven front door - Rewrite docs/README.md as documentation index with reading paths - Add docs/quick-start/ with SSH and HTTP 5-minute guides - Add docs/concepts/ README, script-execution-model, and platform-lifecycle - Add docs/tutorials/ README and building-a-complete-platform capstone tutorial - Add docs/guides/ README with categorized guide index - Add docs/reference/ README with command lookup tables
- Update all internal links in guides, reference, and tutorials - Fix SampleScripts/* paths to samples/* throughout - Fix getting-started/* paths to tutorials/*, guides/*, or concepts/* - Fix guides/feature-flags.md links to concepts/feature-flags.md - Update compatibility.md relative links for new location - Update .github/workflows paths and branch target (master to main) - Update .vscode/settings.json schema fileMatch patterns - Update CONTRIBUTING.md and schema/README.md paths - Update templates/README.md content and links
- Add samples/README.md catalog with selection guidance - Add samples/ssh/README.md with SSH setup instructions - Add samples/http/README.md with HTTP setup instructions - Add samples/telnet/README.md with Telnet setup instructions - Add individual README.md for each of the 16 sample scripts - Each companion doc covers: purpose, operations, prerequisites, deployment
- Remove trailing commas in LinuxSshBatchModeExample.json - Remove trailing commas in Okta_WithDiscoveryAndGroupMembershipRestore.json - Remove trailing commas in RestrictedAuthorizedKeyExample.json - Remove double comma and trailing commas in OneLogin_GRC_JIT_addon.json - Remove UTF-8 BOM from GenericRacfTn3270.json These errors pre-date the reorganization but were never caught because the CI workflow previously targeted the unused master branch.
Covers the browser-form login pattern: fetch page, extract form, fill credentials, submit. Includes guidance on adapting field names, XPath selection, cookie handling, and ContainsSecret masking.
Every page now has a [← Parent](link) backlink on the first line, pointing to its immediate section README. Updated existing backlinks that pointed directly to docs/README.md to point to their section index instead (e.g., Guides, Concepts, Tutorials, Reference).
Both tutorials now walk the reader through a complete platform with CheckSystem, CheckPassword, and ChangePassword instead of deferring ChangePassword to 'look at a sample'. The SSH tutorial teaches the interactive Send/Receive pattern with sudo passwd. The HTTP tutorial teaches admin-authenticated PUT to a password endpoint.
The first-script tutorials now cover ChangePassword, so the capstone no longer re-teaches CheckSystem/CheckPassword/ChangePassword from scratch. Instead it focuses on what's new: DiscoverAccounts, reusable Functions, Try/Catch error handling, and Status messages. Uses correct command syntax consistent with the rest of the documentation.
The assets/ folder contained 23 screenshots and a video showing how to configure the OneLogin JIT add-on end-to-end, but the README never referenced them. Added a 9-step Configuration Walkthrough section that embeds each screenshot with descriptions covering: uploading the platform script, understanding OneLogin roles, creating JIT assets, configuring accounts and privilege group memberships, setting up dynamic account groups, and configuring entitlements with access request policies.
Each sample README now has a 'Platform Script: [filename.json](./file)' link near the top, making it easy to click through to the actual script file from the documentation. Previously the filename only appeared inside a code block in the Deployment section.
| - **`SetFormValue`** updates a field before submission — hidden fields are preserved automatically | ||
| - **`Cookies`** must be enabled so session cookies flow between requests | ||
| - **`ContainsSecret: true`** on password fields prevents credentials from appearing in logs | ||
| - The form's `Action` attribute is available as `%LoginForm.Action%` for the submit URL |
Contributor
There was a problem hiding this comment.
Hmm, I'm confused. When did this become available? Maybe I need to see a working example or something. Can you show a video or something of working example code that makes a request, then uses ExtractFormData, then outputs the form's Action value to the log.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR restructures the repository documentation for better discoverability and navigation. The content quality from the recent modernization is excellent -- this reorganization makes it accessible to different audiences.
What Changed
New Structure
Navigation
Cross-References
Commits
No Content Removed
All existing documentation is preserved. This is purely reorganization plus new navigation/context material.