securesauce / precaution-beta

Precaution provides a simple, automated code review for GitHub projects by running code linters with a security focus on pull requests.

Other

1 stars 0 forks source link

Edit doc landing page and add one additional doc page #251

Closed Stanislava101 closed 3 years ago

Stanislava101 commented 4 years ago

The new doc file is created to help developers to trace webhooks sent by Github and receive them without exposing user app to the internet.

The docs/index.md has documentation both for contributers and users and it is a good idea to have them regroup in to two groups for clarity.

Fix for issue https://github.com/vmware/precaution/issues/243.

Signed-off-by: Stanislava Georgieva stanislava.krasimirovaa@abv.bg

vmwclabot commented 4 years ago

@Stanislava101, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

Commit 20d1b5b504435c5034c0ccde60472575b838a423 must be signed by stanislava.krasimirovaa@abv.bg

codecov-io commented 4 years ago

Codecov Report

Merging #251 into master will not change coverage. The diff coverage is n/a.

@@          Coverage Diff           @@
##           master    #251   +/-   ##
======================================
  Coverage    98.3%   98.3%           
======================================
  Files          18      18           
  Lines         355     355           
  Branches       38      38           
======================================
  Hits          349     349           
  Misses          6       6

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 4dc6c38...33d0639. Read the comment docs.

MVrachev commented 4 years ago

I noticed another thing: @Stanislava101 you created a new file docs/redirect_github_webhooks but where do you reference it? Why do you need it? I think this file belongs to the Setting up for manual deployment doc.

Stanislava101 commented 4 years ago

I noticed another thing: @Stanislava101 you created a new file docs/redirect_github_webhooks but where do you reference it? Why do you need it? I think this file belongs to the Setting up for manual deployment doc.

Before it was there but I thought that if it is more separated it is more clear. My idea is in Setting up a manual deployment file to have the steps needed for Setting up a manual deployment and redirect Github webhooks to be in another file.

MVrachev commented 4 years ago

Before it was there but I thought that if it is more separated it is more clear. My idea is in Setting up a manual deployment file to have the steps needed for Setting up a manual deployment and redirect Github webhooks to be in another file.

Yes, but Redirecting the GitHub webhooks to your local machine is essential for your local development. That's why it's better if it stays where it is. Currently, in the documentation, it doesn't seem like this is so important. I will fix that.

MVrachev commented 4 years ago

Yes, but Redirecting the GitHub webhooks to your local machine is essential for your local development. That's why it's better if it stays where it is. Currently, in the documentation, it doesn't seem like this is so important. I will fix that.

Added pr https://github.com/vmware/precaution/pull/252 which fixes that.