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

Update wording in install-a-demo.md #2233

Merged
merged 3 commits into from
May 31, 2023
Merged

Update wording in install-a-demo.md #2233

merged 3 commits into from
May 31, 2023

Conversation

rosiel
Copy link
Member

@rosiel rosiel commented May 24, 2023

Purpose / why

I was confused by the installation instructions, and I find this wording clearer.

What changes were made?

  • minor wording adjustments to capitalize the Starter Site, clarify overlap of content, use the word "demo" consistently and as a common noun
  • Included a step missing from the docs for first-time Portainer users
  • Clarify (what I think is) the order of operations.

Verification

Interested Parties

  • @Islandora/documentation
  • @Islandora/committers

Checklist

Pull-request Reviewer

Pull-request reviewer should ensure the following:

Person Merging

The person merging should ensure the following:

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

@ysuarez ysuarez self-requested a review May 24, 2023 17:11
@ysuarez
Copy link
Contributor

ysuarez commented May 24, 2023

If I have time I will uninstall Portianer plugin when I test this.

Copy link
Contributor

@ysuarez ysuarez left a comment

Choose a reason for hiding this comment

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

This is an improvement of the curent docs. This should be merged.

@@ -47,33 +47,34 @@ and running. You can now setup your demo.

Get a Yaml file
--------------------------------------------------------------
[Download this .zip file](https://drive.google.com/file/d/1LrIe12eYAZjD4A8_cqf61RXv7mtMJRHH/view?usp=share_link) and use the yaml file provided inside.
Download the [Starter-Site-based demo from Google Drive](https://drive.google.com/file/d/1LrIe12eYAZjD4A8_cqf61RXv7mtMJRHH/view?usp=share_link) and find the `docker-compose.yml` file provided inside. This will be used in the next step.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this updated line is an improvement, but my first thought is that we should make it a bit more clear that they have to download a ".zip" file. Since the Google Drive UI puts the actual download button on the upper right, and may not be clear to some folks how to actually download the ".zip" file since I am not sure you can try to download only the ".yml" file via Google Drive.

Copy link
Member Author

Choose a reason for hiding this comment

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

Agreed!

@ysuarez ysuarez merged commit c34ca6d into main May 31, 2023
@rosiel rosiel deleted the rosiel-patch-2 branch June 15, 2023 18:47
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.

2 participants