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 to support cloud storage for Cloud exports #6545

Merged
merged 8 commits into from
Jul 26, 2023
Merged

Docs to support cloud storage for Cloud exports #6545

merged 8 commits into from
Jul 26, 2023

Conversation

cwarnermm
Copy link
Member

@cwarnermm cwarnermm commented Jul 20, 2023 •
edited
Loading

Documentation for: mattermost/mattermost#23915

@cwarnermm cwarnermm added the Work In Progress Not yet ready for review label Jul 20, 2023
@github-actions
Copy link

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

@github-actions
Copy link

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

@cwarnermm
Copy link
Member Author

@JulienTant - Can you provide a sample of the progress/list of the exports ready to download via URL that I can include in this docs PR, please?

@cwarnermm cwarnermm added 1: Dev Review Requires review by a core commiter 1: PM Review Requires review by a product manager and removed Work In Progress Not yet ready for review labels Jul 21, 2023
@github-actions
Copy link

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

@github-actions
Copy link

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

nab-77
nab-77 reviewed Jul 21, 2023
View reviewed changes
source/manage/cloud-data-export.rst Outdated

mmctl export download r3kcj8yuwbramdt714doafi3oo_export.zip
From your Mattermost Cloud web instance, retrieve the file download link to the export by using the Mattermost slash command ``/exportlink [job-id|zip file|latest]``. Use the ``latest`` option to automatically pull the latest export available, or specify the download link by ``job-id`` or ``zip file``.
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to be explicit as to where to run the slash command. Recommend we explain "hopping" over to the webapp to run the slash command and download the export.

source/manage/cloud-data-export.rst Outdated

.. code::

Export process job successfully created, ID: yfrr9ku5i7fjubeshs1ksrknzc
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add a section similar to that on the local export tab explaining how to show export job lists and how to check when the job is ready

@JulienTant
Copy link
Member

@cwarnermm sorry it took me so long to give an answer to your request 😊

The command mmctl export list

Will output this sort result:

5taugpccspnybcbkd6hxycpjsr_export.zip
aapttb7q3bfd8xz8xj9wfax3gy_export.zip
gs1pd8dryib4inz1fk6erqq59e_export.zip


There are 3 exports on local instance

I don't know if you need this piece of in, but the filename structure if {job_id}_export.zip, {job_id} being what you get from running mmctl export create

I'm reviewing the rest of the documentation now!

@github-actions
Copy link

Newest code from JulienTant has been published to preview environment for Git SHA 60a37ca

@github-actions
Copy link

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

@cwarnermm
Copy link
Member Author

Thank you, @JulienTant, for your updates to this docs PR! With your updates in place, I was able to collapse the tabbed content into a single path of work for the admin to complete. This docs PR is now ready for your final review.

@cwarnermm cwarnermm removed the 1: PM Review Requires review by a product manager label Jul 21, 2023
@github-actions
Copy link

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

JulienTant
JulienTant approved these changes Jul 21, 2023
View reviewed changes
Copy link
Member

@JulienTant JulienTant left a comment

Choose a reason for hiding this comment

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

LGTM @cwarnermm! thank you!!

@cwarnermm cwarnermm added 3: Reviews Complete All reviewers have approved the pull request and removed 1: Dev Review Requires review by a core commiter labels Jul 21, 2023
@cwarnermm
Copy link
Member Author

This PR can be merged at any time.

@cwarnermm cwarnermm merged commit f8517fb into master Jul 26, 2023
2 checks passed
@cwarnermm cwarnermm deleted the mm-53454 branch July 26, 2023 12:27
@github-actions
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nab-77 nab-77 nab-77 left review comments

@Willyfrog Willyfrog Willyfrog approved these changes

@JulienTant JulienTant JulienTant approved these changes

Assignees
No one assigned
Labels
3: Reviews Complete All reviewers have approved the pull request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@cwarnermm @JulienTant @Willyfrog @nab-77