Skip to content

Update docs 003a #859

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

Open
wants to merge 26 commits into
base: main
Choose a base branch
from
Open

Update docs 003a #859

wants to merge 26 commits into from

Conversation

KiraLempereur-Spacelift
Copy link
Collaborator

@KiraLempereur-Spacelift KiraLempereur-Spacelift commented Aug 8, 2025

Description of the change

Starting on updates to the Stacks documentation and refining the cloud integration and source code integration docs to reflect info from the new getting started pages.

Checklist

Please make sure that the proposed change checks all the boxes below before requesting a review:

  • I have reviewed the guidelines for contributing to this repository.
  • The preview looks fine.
  • The tests pass.
  • The commit history is clean and meaningful.
  • The pull request is opened against the main branch.
  • The pull request is no longer marked as a draft.
  • You agree to license your contribution under the MIT license to Spacelift (not required for Spacelift employees).
  • You have updated the navigation files correctly:
    • No new pages have been added, or;
    • Only nav.yaml has been updated because the changes only apply to SaaS, or;
    • Only nav.self-hosted.yaml has been updated because the changes only apply to Self-Hosted, or;
    • Both nav.yaml and nav.self-hosted.yaml have been updated.

If the proposed change is ready to be merged, please request a review from @spacelift-io/solutions-engineering. Someone will review and merge the pull request.

Spacelift employees should request reviews from the relevant engineers and are allowed to merge pull requests after they got at least one approval.

Thank you for your contribution! 🙇

Fixed indentation formatting for login policies member and teams sections. Added info on US regional URLs needed for worker pools AWS services. Changed some admonition types.
See https://www.notion.so/spacelift/Branch-update-docs-002-22a251e5616a806f8444d68b519e0f5e for a full list of items that have been added or changed. Some screenshots have also been updated and added.
Updated alt text and SS file for launchpad step 4 (hoping to resolve failed check on PR 847
There's no reason this should be failing, the link to the image is completely valid. Did oxipng ruin something?

Anyways, manually retyped link and we'll see how things go now.
There, pre-commit markdown link check, are you happy now?

Deleted the image link (../../assets/screenshots/getting-started/invite-teammates/Launchpad-step-4-done.png) that was apparently causing 400 error when markdown link check ran on the repo. We'll see if the one on line 78 causes the same error.
the link check will apparently only show me one dead link at a time so hold your horses, let's knock these out.
Removed 7 unused assets (images) from repo
Fixed typos and weird formatting on some pages (nested lists)

Added fresh AWS ARN screenshot
Per request, added a link to custom workflow tool in the OpenTofu/Terraform section
See PR convo for a list of items that were updated
just moved back one level
It was failing with code 403 but I could access the URL just fine myself, so other users should be able to.
Updated several Stacks documentation pages. Updated creating-a-stack to the info from getting started section and combined with deleting and locking stacks. Beginning to update cloud provider details to simply link to setup info in getting started section.
@KiraLempereur-Spacelift
Copy link
Collaborator Author

We just need to update the files that have been altered since update-docs-002 was merged to main. I'll take a look at resolving conflicts next week.

Made links a little more relative so hopefully the pre-commit link check doesn't struggle
Some updates to the stack settings and stack dependencies pages
Changed the links to the ones in the getting started section so hopefully pre-commit doesn't think they're dead
Fixed ALL relative links on the page
Updated dead link to proper one in concepts/run/task.md.

Added aur.archlinux.org URLs to markdown link check ignores, because the links are live.
Removed lots of unused and/or outdated screenshots for stack creations, AWS cloud providers, etc. Fixed reference to one SS in GitHub source control getting started page.
Resolve comments from Jubran's review, note that all scheduling requires private workers, fix capslock CRON, etc. Also copied the new stack nav to self-hosted nav.yaml file
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.

2 participants