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

Documentation site redux #6751

Merged
merged 123 commits into from
Mar 19, 2024
Merged

Documentation site redux #6751

merged 123 commits into from
Mar 19, 2024

Conversation

neflyte
Copy link
Contributor

@neflyte neflyte commented Oct 30, 2023 •
edited by cwarnermm
Loading

Summary

This PR migrates the product docs site to a new Sphinx theme, furo, and upgrades Sphinx and its extensions to the latest releases.

Before building this branch for the first time, please make sure you have run pipenv sync --dev to update Sphinx and its dependencies.

Development Note: Currently building using Python 3.11; however, Mattermost pipelines use Python 3.9. Test all changes against Python 3.9 and Python 3.11 ahead of go-live. When go-live ready, bump pipelines to Python 3.11 to take advantage of incremental improvements.

@neflyte
Apply changes from redux proof-of-concept; Update tests; Add workarou…
1aa78bf 
…nd for furo template rendering; Update README
@mattermost-build
Copy link
Contributor

Hello @neflyte,

Thanks for your pull request! A Core Committer will review your pull request soon. For code contributions, you can learn more about the review process here.

@cwarnermm cwarnermm self-requested a review October 30, 2023 13:06
@cwarnermm cwarnermm added the preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories label Oct 30, 2023
@github-actions
Copy link

Preview environment failed.

2 similar comments
@github-actions
Copy link

Preview environment failed.

@github-actions
Copy link

Preview environment failed.

@cwarnermm cwarnermm added the Work In Progress Not yet ready for review label Oct 31, 2023
@cwarnermm cwarnermm added preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories and removed preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories labels Nov 3, 2023
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 3, 2023

Newest code from cwarnermm has been published to preview environment for Git SHA 2ff4096

@cwarnermm
Copy link
Member

/update-branch

@cwarnermm cwarnermm added preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories and removed preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories labels Nov 13, 2023
@cwarnermm cwarnermm removed the preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories label Nov 13, 2023
@cwarnermm cwarnermm added preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories and removed preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories labels Mar 15, 2024
@github-actions GitHub Actions
Copy link

Newest code from cwarnermm has been published to preview environment for Git SHA 1dd62a9

@emdecr
Copy link
Contributor

emdecr commented Mar 18, 2024

Hey @cwarnermm - circling back on the Google Tag Manager (GTM) + feedback telemetry/analytics discussion:

I'm not sure how we can install the GTM properly without adding a base.html file since it holds the <head> element. But I remember it's advised not to mess with the base.html template.

We currently use the layout templates to add the snippet, but furo doesn't seem to support that.

Anyone have any ideas about how to tackle? Does using our own version of the base template break everything? We tried it before, but that seems to cause errors?

cc: @neflyte and @asaadmahmood for visibility

@neflyte
Copy link
Contributor Author

neflyte commented Mar 18, 2024

I added Google Tag Manager support to page.html and left some test feedback; hopefully it's reflected in Looker. :) There were a couple nice places to insert the GTM scripts that align with furo!

@cwarnermm cwarnermm added preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories and removed preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories labels Mar 19, 2024
@github-actions GitHub Actions
Copy link

Newest code from cwarnermm has been published to preview environment for Git SHA ee78dbe

@cwarnermm cwarnermm added preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories and removed Work In Progress Not yet ready for review preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories labels Mar 19, 2024
@cwarnermm
Copy link
Member

/update-branch

@github-actions GitHub Actions
Copy link

Newest code from cwarnermm has been published to preview environment for Git SHA cc712c2

@cwarnermm cwarnermm added preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories and removed preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories labels Mar 19, 2024
@cwarnermm
Copy link
Member

/update-branch

@github-actions GitHub Actions
Copy link

Newest code from cwarnermm has been published to preview environment for Git SHA b329b18

cwarnermm
cwarnermm approved these changes Mar 19, 2024
View reviewed changes
Copy link
Member

@cwarnermm cwarnermm left a comment

Choose a reason for hiding this comment

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

Huge shoutouts to @neflyte, @emdecr, and @asaadmahmood for supporting this significant product docs lift.

@cwarnermm cwarnermm merged commit 7122b47 into mattermost:master Mar 19, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cwarnermm cwarnermm cwarnermm approved these changes

Assignees
No one assigned
Labels
Contributor Hacktoberfest null preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@neflyte @mattermost-build @cwarnermm @emdecr @asaadmahmood