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

chore: added user docs #80

Merged
merged 5 commits into from
Jan 16, 2023
Merged

chore: added user docs #80

merged 5 commits into from
Jan 16, 2023

Conversation

tiftran
Copy link
Contributor

@tiftran tiftran commented Jan 16, 2023

Originally had this as a google doc, but realized it's probs better to have it inside the repo instead for maintainability

@tiftran tiftran requested a review from a team January 16, 2023 03:36

- Dev: https://shepherd-dev.topsites.nonprod.cloudops.mozgcp.net/admin
- Stage: https://shepherd-stage.topsites.nonprod.cloudops.mozgcp.net/admin/
- Prod: https://shepherd-stage.topsites.nonprod.cloudops.mozgcp.net/admin/
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be the prod URL.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

eek

Copy link
Contributor

@mtbottle mtbottle left a comment

Choose a reason for hiding this comment

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

Also, nit (I highlighted a few, but didn't comment on all): url should probably be capitalized into URL.

docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
docs/UserGuide.md Outdated Show resolved Hide resolved
Comment on lines 25 to 28
From the main admin page under the Contile subsection click the Add Advertisers Button.
Fill in the info required. Adding more urls for an advertiser, there is a green “+”
under the Geo group dropdown. Click “Save” once you’re done. Red text will appear around certain textboxes if the value violates validation requirements.
Correct them and hit save again. A successful save will have a green bar near the top of the page that says so.
Copy link
Contributor

Choose a reason for hiding this comment

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

What do you think about making this a numbered list for readability?

Suggested change
From the main admin page under the Contile subsection click the Add Advertisers Button.
Fill in the info required. Adding more urls for an advertiser, there is a green “+”
under the Geo group dropdown. Click “Save” once you’re done. Red text will appear around certain textboxes if the value violates validation requirements.
Correct them and hit save again. A successful save will have a green bar near the top of the page that says so.
From the main admin page under the Contile subsection:
1. Click the `Add Advertisers` button.
2. Fill in the info required.
...

Copy link
Contributor

Choose a reason for hiding this comment

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

Same question applies to the section below.

tiftran and others added 4 commits January 16, 2023 07:50
Co-authored-by: Michelle Tran <email@michtran.ca>
Co-authored-by: Michelle Tran <email@michtran.ca>
Co-authored-by: Michelle Tran <email@michtran.ca>
Copy link
Contributor

@mtbottle mtbottle left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀 Thanks for putting the docs here!

@tiftran tiftran merged commit 5e2afde into main Jan 16, 2023
@tiftran tiftran deleted the docs branch June 8, 2023 17:12
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.

None yet

2 participants