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.

Sign up for GitHub

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

Jump to bottom

docs: document motd configuration #49526

Merged
merged 6 commits into from
Dec 2, 2024
Merged

docs: document motd configuration #49526

merged 6 commits into from
Dec 2, 2024

Conversation

stevenGravy
Copy link
Contributor

The MOTD, esp the dynamic config, was not clearly documented.

@stevenGravy stevenGravy added no-changelog Indicates that a PR does not require a changelog entry backport/branch/v15 backport/branch/v16 backport/branch/v17 labels Nov 27, 2024
@github-actions GitHub Actions
Copy link

🤖 Vercel preview here: https://docs-jam3tupmt-goteleport.vercel.app/docs

@github-actions GitHub Actions
Copy link

🤖 Vercel preview here: https://docs-2zrg28v6m-goteleport.vercel.app/docs

ptgott
ptgott reviewed Dec 2, 2024
View reviewed changes
docs/pages/reference/access-controls/authentication.mdx Outdated Show resolved Hide resolved
docs/pages/reference/access-controls/authentication.mdx Outdated Show resolved Hide resolved
docs/pages/reference/access-controls/authentication.mdx Outdated Show resolved Hide resolved
docs/pages/reference/access-controls/authentication.mdx Outdated
message_of_the_day: "\n Welcome to the Example Teleport Cluster\n All activity is monitored and should follow organization policies\n"
```

Restart the Teleport Auth services to apply this change.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are we capitalizing the name of the Teleport Auth Service like this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ptgott please see updates.

@stevenGravy @ptgott
docs: update verabiage for motd
a982c6a 
Co-authored-by: Paul Gottschling <[email protected]>
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 2, 2024

🤖 Vercel preview here: https://docs-9opb3jyc9-goteleport.vercel.app/docs

@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 2, 2024

🤖 Vercel preview here: https://docs-p7ozf6nzl-goteleport.vercel.app/docs

@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 2, 2024

🤖 Vercel preview here: https://docs-8f4d3ier3-goteleport.vercel.app/docs

mmcallister
mmcallister approved these changes Dec 2, 2024
View reviewed changes
Copy link
Contributor

@mmcallister mmcallister left a comment

Choose a reason for hiding this comment

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

Would it be worthwhile to note that \n is for new lines in the message?

@stevenGravy stevenGravy added this pull request to the merge queue Dec 2, 2024
Merged via the queue into master with commit 42172ce Dec 2, 2024
40 checks passed
@stevenGravy stevenGravy deleted the stevenGray/docs/motd branch December 2, 2024 21:54
@public-teleport-github-review-bot
Copy link

@stevenGravy See the table below for backport results.

Branch Result
branch/v15 Create PR
branch/v16 Create PR
branch/v17 Create PR

@zmb3
Copy link
Collaborator

zmb3 commented Dec 2, 2024

Would it be worthwhile to note that \n is for new lines in the message?

Yes, or better yet we should done this:

  message_of_the_day: |
    Welcome to the Example Teleport Cluster
    All activity is monitored and should follow organization policies

No need to quote or use escape characters and it's way easier to read.

zmb3
zmb3 reviewed Dec 2, 2024
View reviewed changes
docs/pages/reference/access-controls/authentication.mdx

```yaml
auth_service:
message_of_the_day: "\n Welcome to the Example Teleport Cluster\n All activity is monitored and should follow organization policies\n"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Also the indentation here looks off.

This was referenced Dec 3, 2024
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zmb3 zmb3 zmb3 left review comments

@ptgott ptgott ptgott approved these changes

@mmcallister mmcallister mmcallister approved these changes

@tigrato tigrato tigrato approved these changes

Assignees
No one assigned
Labels
backport/branch/v15 backport/branch/v16 backport/branch/v17 documentation no-changelog Indicates that a PR does not require a changelog entry size/sm
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@stevenGravy @zmb3 @tigrato @mmcallister @ptgott