Skip to content

Olivekl new install instructions #46

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
Merged
merged 31 commits into from
Jan 12, 2022
Merged

Olivekl new install instructions #46

merged 31 commits into from
Jan 12, 2022

Conversation

@olivekl
Copy link
Contributor

@olivekl olivekl commented Jan 6, 2022 •
edited
Loading

New install instructions, including screenshots.

@olivekl olivekl requested a review from laurentsimon January 6, 2022 21:09
@laurentsimon
Copy link
Contributor

laurentsimon commented Jan 6, 2022

DRAFT, DO NOT MERGE

Draft of new installation instructions. Sharing for comments before I add screenshots and links.

Questions: -Is everything accurate and easy to follow?

I think we could get rid of it.

-Do we need to include the "manual" option at the bottom? Will anyone want to set up the action values themselves, or are they useful for any other reason?

I copied this from other actions' README. But other actions out there are not available under the Security tab, so that's why they need it.

@azeemshaikh38 wdut?

azeemshaikh38
azeemshaikh38 reviewed Jan 6, 2022
View reviewed changes
@azeemshaikh38
Copy link
Contributor

azeemshaikh38 commented Jan 6, 2022

DRAFT, DO NOT MERGE
Draft of new installation instructions. Sharing for comments before I add screenshots and links.
Questions: -Is everything accurate and easy to follow?

I think we could get rid of it.

-Do we need to include the "manual" option at the bottom? Will anyone want to set up the action values themselves, or are they useful for any other reason?

I copied this from other actions' README. But other actions out there are not available under the Security tab, so that's why they need it.

@azeemshaikh38 wdut?

I think its ok to keep the manual part of the setup for more advanced users.

@olivekl
Update README.md
62d250c 
Address comments on draft PR
@olivekl
Copy link
Contributor Author

olivekl commented Jan 7, 2022 •
edited
Loading

Thanks, @azeemshaikh38 . I addressed your comments. I'll add screenshots for the UI section if everything else looks good.

olivekl added 8 commits January 7, 2022 13:51
@olivekl
Merge branch 'ossf:main' into olivekl-new-install-instructions
4e1227b
@olivekl
Create images folder
cfc46b0 
New folder for installation screenshot (delete placeholder.md after merging)
@olivekl
Add files via upload
56bd872 
Screenshots for installation instructions
@olivekl
Delete placeholder.md
e2c6eaf 
Remove placeholder file, no longer needed
@olivekl
Update README.md
8fa6f4f 
Add screenshots to install instructions.
@olivekl
Update README.md
1b19463 
Change suggested name of secret to SCORECARD_READ_SECRET so users know it's read only
@olivekl
Add files via upload
8b0957b 
Add token permission image to images folder
@olivekl
Update README.md
4683413 
Change SCORECARD_READ_SECRET back to _TOKEN 
Add screenshot of permissions
@olivekl olivekl marked this pull request as ready for review January 10, 2022 22:19
@laurentsimon laurentsimon mentioned this pull request Jan 10, 2022
Merged
laurentsimon
laurentsimon reviewed Jan 11, 2022
View reviewed changes
@olivekl
Update README.md
761151d 
Address PR comments
@olivekl
Update README.md
82d3661 
Address PR comments
@olivekl
Add files via upload
a564f59 
Add images for installation screenshots
laurentsimon
laurentsimon reviewed Jan 11, 2022
View reviewed changes
@olivekl
Update README.md
70338db 
Update private repo support description
laurentsimon
laurentsimon reviewed Jan 11, 2022
View reviewed changes
@olivekl
Update README.md
da9bc05 
Fix typo
Update Publish Results and workflow example to account for private repo support
@olivekl
Delete remediaton.png
3963a8a 
delete image to replace
@olivekl
Delete actionconfim.png
9229ce3 
delete image to replace
@olivekl
Add files via upload
5a5de2f 
Add images
@olivekl
Update README.md
17286b4 
Add screenshots of confirming actions and remediation expansion
@olivekl
Delete actionconfim.png
5478ffa
@olivekl
Add files via upload
9c5808e
@olivekl
Update README.md
b62c93e 
Try to fix line wrapping issue
@olivekl
Update README.md
b23d1fe 
Add spaces before images
laurentsimon
laurentsimon approved these changes Jan 12, 2022
View reviewed changes
Copy link
Contributor

@laurentsimon laurentsimon left a comment

Choose a reason for hiding this comment

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

Thank you!

@laurentsimon
Copy link
Contributor

laurentsimon commented Jan 12, 2022

We just need to rebase the PR.

@laurentsimon laurentsimon merged commit 13e780c into ossf:main Jan 12, 2022
@olivekl olivekl deleted the olivekl-new-install-instructions branch January 12, 2022 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@azeemshaikh38 azeemshaikh38 azeemshaikh38 approved these changes

@laurentsimon laurentsimon laurentsimon approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@olivekl @laurentsimon @azeemshaikh38