-
Notifications
You must be signed in to change notification settings - Fork 1
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
Conversation
docs/UserGuide.md
Outdated
|
||
- 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/ |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
eek
There was a problem hiding this 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
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. |
There was a problem hiding this comment.
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?
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. | |
... |
There was a problem hiding this comment.
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.
Co-authored-by: Michelle Tran <email@michtran.ca>
Co-authored-by: Michelle Tran <email@michtran.ca>
Co-authored-by: Michelle Tran <email@michtran.ca>
There was a problem hiding this 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!
Originally had this as a google doc, but realized it's probs better to have it inside the repo instead for maintainability