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

add Mattermost linking mechanism #148

Merged
merged 1 commit into from
Nov 29, 2023
Merged

add Mattermost linking mechanism #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .sphinx/_templates/footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@
</div>
{% endif %}

{% if mattermost %}
<div class="ask-mattermost">
<a class="muted-link" href="{{ mattermost }}">Ask a question on Mattermost</a>
Copy link

Choose a reason for hiding this comment

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

There's currently a mattermost key in custom_conf.py that makes this work but what was the use of it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pmatulis it's introduced by the same PR, and the intended use is the same as for discourse:
https://github.com/canonical/sphinx-docs-starter-pack/pull/148/files

Copy link

Choose a reason for hiding this comment

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

oh i missed that

</div>
{% endif %}

{% if github_url and github_version and github_folder %}

{% if github_issues %}
Expand Down
1 change: 1 addition & 0 deletions .wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Juju
Kubernetes
Kubeflow
Makefile
Mattermost
MyST
namespace
namespaces
Expand Down
4 changes: 4 additions & 0 deletions custom_conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@
# (use an empty value if you don't want to link)
'discourse': 'https://discourse.ubuntu.com',

# Change to the Mattermost channel you want to link to
# (use an empty value if you don't want to link)
'mattermost': 'https://chat.canonical.com/canonical/channels/documentation',

# Change to the GitHub URL for your project
'github_url': 'https://github.com/canonical/starter-pack',

Expand Down