Skip to content
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

Edited Slack Docs #553

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

maxehio
Copy link

@maxehio maxehio commented Jul 12, 2024

Description of the change

At the bottom of our documentation for slack we say "Available Slash Commands", then there is little message that says:

It's recommended to instead use the notification policy in order to manage slack messages received from Spacelift. These slash commands are deprecated.

After that it says:

Three slash commands are currently available:
/spacelift subscribe $stackId - subscribes a particular Slack channel to run state changes for a given Stack - requires ;
/spacelift unsubscribe $stackId - unsubscribes a particular Slack channel from run state changes for a given Stack;
/spacelift trigger $stackId - triggers a tracked run for the specified Stack;

This is misleading if slack commands are deprecated so I just removed it altogether.

In addition, there is a paragraph that says:

Installing the Slack app doesn't automatically cause Spacelift to flood your Slack channels with torrents of notifications. These are set up on a per-stack basis using Slack commands and the management uses the Slack interface.

That hyperlink under "Slack commands" directs the user nowhere. So I adjusted that as well to direct a user to a helpful link.

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.

…tion and removed depracted info from the slack page
@maxehio maxehio requested a review from a team July 12, 2024 21:38
Copy link
Contributor

@Daniellem97 Daniellem97 left a comment

Choose a reason for hiding this comment

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

Notification policies are actually space wide, not per stack

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.

None yet

2 participants