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

Example updates #82

Merged
merged 8 commits into from
Sep 25, 2023
Merged

Example updates #82

merged 8 commits into from
Sep 25, 2023

Conversation

l50
Copy link
Contributor

@l50 l50 commented Sep 15, 2023

Proposed Changes

This pull request (PR) proposes documentation updates for the TTPForge project based on the changes made in the recent commit. The changes include updates to several README files within the ttps/examples directory, specifically:

  1. Updates to args example:

    • Created documentation to provide a description of the TTP's purpose and steps.
    • Included expected output for each step of the TTP.
  2. Created mitre example

    • Created a new mitre example with a README describing the functionality of the step and how to run it.
    • Included expected output for each step of the TTP.
  3. Updates to outputs example:

    • Created documentation to provide a description of the TTP's purpose and steps.
    • Included expected output for each step of the TTP.
  4. Updates to edit-step example

    • Created documentation to provide a description of the TTP's purpose and steps.
    • Included expected output for each step of the TTP.
  5. Updates to sub-ttps example

    • Created documentation to provide a description of the TTP's purpose and steps.
    • Included expected output for each step of the TTP.
  6. Created fetchuri example:

    • Created a new fetchuri example with a README describing the functionality of the step and how to run it.
    • Included expected output for each step of the TTP.

Related Issue(s)

No related issues are associated with this PR.

Testing

N/A

Documentation

Updated and added documentation for various TTP examples within the ttps/examples directory.

Screenshots/GIFs (optional)

N/A

Checklist

  • Ran mage runprecommit locally and fixed any issues that arose.
  • Curated your commit(s) so they are legible and easy to read and understand.
  • 🚀

@d3sch41n
Copy link
Contributor

Back from PTO - I need to review the targets TTPForge PR today, however everything else looks fine so if you want to set the targets docs to the side for a bit, can merge everything else now - LMK

@l50
Copy link
Contributor Author

l50 commented Sep 18, 2023

Back from PTO - I need to review the targets TTPForge PR today, however everything else looks fine so if you want to set the targets docs to the side for a bit, can merge everything else now - LMK

All good, I'll wait on your review before we merge.

l50 added 5 commits September 20, 2023 11:09
Authored-by: Jayson Grace <jayson.e.grace@gmail.com>
- Enhanced titles and descriptions for improved comprehension.
- Streamlined instructions for running demonstrations.
- Adjusted formatting for better visual distinction of sections.
- Renamed certain files for naming consistency.

Authored-by: Jayson Grace <jayson.e.grace@gmail.com>
Authored-by: Jayson Grace <jayson.e.grace@gmail.com>
Copy link
Contributor

@d3sch41n d3sch41n left a comment

Choose a reason for hiding this comment

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

Plz remove ignore-errors

- Need to work on targets a bit more
- We're not going to add `ignore_errors` - it has the potential
  to create a lot of quality control issues

Authored-by: Jayson Grace <jayson.e.grace@gmail.com>
@l50
Copy link
Contributor Author

l50 commented Sep 21, 2023

Plz remove ignore-errors

Whoops, good catch! Done.

@l50 l50 requested a review from d3sch41n September 21, 2023 19:12
Authored-by: Jayson Grace <jayson.e.grace@gmail.com>
cat file-to-edit.txt
- name: edit-target-file
edit_file: "file-to-edit.txt"
backup_file: "my-backup.txt"
backup_file: "/tmp/my-backup.txt"
Copy link
Contributor

Choose a reason for hiding this comment

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

I'll fix this first

Copy link
Contributor Author

@l50 l50 Sep 22, 2023

Choose a reason for hiding this comment

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

Sounds good. Yeah, basically it drops the backup in the CWD, which is different from where Forge expects it to be in relation to the original file. Hence the absolute path.

Copy link
Contributor

@d3sch41n d3sch41n left a comment

Choose a reason for hiding this comment

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

i'll go back and update the edit for the appropriate fix later

@l50 l50 merged commit 864de28 into facebookincubator:main Sep 25, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants