Skip to content

Conversation

@BioPhoton
Copy link
Collaborator

@BioPhoton BioPhoton commented Nov 24, 2023

This PR adds documentation about custom plugins to the cli docs.

Notice:
I would like to get feedback in the following way:

  1. the pr gets reviewed only for structure, sections and order
  • reduce size of sections
  1. the pr gets wording polish and rough feedback on code examples
  • SEO
  • persona centric wording
  • reduce code complexity
  • reduce code and types to a minimum
  • add detail tags to reduce initially visual code
  • code imports are added
  1. the pr goes into ready for final review
  • remove todos
  • last check

I will also resolve the possible comments in the following order.

Todos:

  • structure, sections and order is correct
    • First feedback
      introduced more sections on data strucutres and added links to other docs.
  • Rework v2
Screenshot 2023-12-03 at 22 44 39
  • wording and code examples are polished
    • First feedback
      • added in-site links and notes to missing links
      • added intro section
      • add docs to file-size plugin example
    • added links and polished text

closes #117

@BioPhoton BioPhoton self-assigned this Nov 24, 2023
@BioPhoton BioPhoton added the 📖 Project documentation improvements or additions to the project documentation label Nov 24, 2023
@BioPhoton BioPhoton added this to the 2. Integration milestone Nov 24, 2023
Copy link
Contributor

@IKatsuba IKatsuba left a comment

Choose a reason for hiding this comment

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

Left some comments

@BioPhoton BioPhoton marked this pull request as ready for review November 25, 2023 15:43
IKatsuba
IKatsuba previously approved these changes Nov 27, 2023
Copy link
Collaborator

@matejchalk matejchalk left a comment

Choose a reason for hiding this comment

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

Overall I think this is a very good step-by-step guide. My only note on structure is I wouldn't include it the CLI README, because it's quite long and only relevant for plugin authors, making it more of an advanced topic. I would move into a separate Markdown file (e.g. docs/plugin-tutorial.md), and only include a link here.

Otherwise I had some more detailed notes in the comments.

@BioPhoton
Copy link
Collaborator Author

BioPhoton commented Nov 28, 2023

I had more thoughts on the chapters "Scoring of audits" and "Attribution of audits"... I think it is a better learning if we direclty stick to the data structure and I arite more in the context of audits.

So the new COT could look like this:

    1. Custom Plugins
    • 1.1. Metadata
    • 1.1. Add a plugin to core config
    • 1.2. Runner
      • 1.2.1. RunnerFunction
      • 1.2.2. RunnerConfig
    • 1.3. AuditOutput
      • 1.3.1. Metadata
      • 1.3.1. Scoring
      • 1.3.2. Attribution
    • 1.4. Groups
    1. Plugins and categories

Co-authored-by: Matěj Chalk <[email protected]>
Co-authored-by: Kateřina Pilátová <[email protected]>
@BioPhoton BioPhoton changed the title docs(cli): custom plugins docs(cli): add docs for custom plugins Nov 28, 2023
Copy link
Collaborator

@Tlacenka Tlacenka left a comment

Choose a reason for hiding this comment

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

I like it!

Just wondering whether the removal of the second file is intentional, the text seemed well split where the CLI was a high-level introduction and the main custom plugins was more of a tutorial. 🤔

BioPhoton and others added 2 commits December 1, 2023 14:50
Copy link
Collaborator

@Tlacenka Tlacenka left a comment

Choose a reason for hiding this comment

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

Looking good!

A few TODOs are still left (links to models). Is this desired?

Tlacenka
Tlacenka previously approved these changes Dec 14, 2023
Copy link
Collaborator

@Tlacenka Tlacenka left a comment

Choose a reason for hiding this comment

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

Except for the todos, great improvement, well documented user journey towards custom plugins! 💯

@BioPhoton BioPhoton merged commit a026a31 into main Dec 14, 2023
@BioPhoton BioPhoton deleted the docs-custom-plugins branch December 14, 2023 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🧩 cli 🧩 models 📖 Project documentation improvements or additions to the project documentation 🔬 testing writing tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document how to create a plugin

7 participants