Skip to content

Update fides_module.md again#1494

Closed
eldraco wants to merge 1 commit intodevelopfrom
eldraco-patch-doc-fides-2
Closed

Update fides_module.md again#1494
eldraco wants to merge 1 commit intodevelopfrom
eldraco-patch-doc-fides-2

Conversation

@eldraco
Copy link
Copy Markdown
Collaborator

@eldraco eldraco commented May 22, 2025

An update to PR Update fides_module.md documentation

Check List (Check all the applicable boxes)

  • My code follows the code style of this project.
  • My change requires changes to the documentation.
  • I have updated the documentation accordingly.
  • All new and existing tests passed.
  • This PR does not contain plagiarized content.
  • The title of my pull request is a short description of the requested changes.
  • My PR is based on develop branch. (mandatory)

An update to PR Update fides_module.md documentation
@eldraco eldraco added this to Slips May 22, 2025
@eldraco eldraco added the Documentation Related to documentation label May 22, 2025
@github-project-automation github-project-automation Bot moved this to Todo in Slips May 22, 2025
@AlyaGomaa AlyaGomaa changed the base branch from master to develop May 23, 2025 18:03
Copy link
Copy Markdown

@JiwaniZakir JiwaniZakir left a comment

Choose a reason for hiding this comment

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

The removal of the ## Installation section from docs/fides_module.md eliminates the only place that explicitly mentioned the --use_fides=True flag and its behavioral caveat (that it's ignored when Slips runs on a file rather than an interface). While the docker pull/run commands appear redundant with the block already present at the top of the file, the note about interface-only operation carries important information that isn't captured anywhere else in this document. Before removing it entirely, consider folding that caveat into the ### Configuration section or the existing docker run example at the top, so users aren't left without guidance on the interface-only restriction. Additionally, the original note contained a typo ("lease" instead of "please"), which suggests the section may have been understated rather than truly redundant — worth preserving with a fix rather than a wholesale deletion.

@eldraco eldraco closed this Apr 28, 2026
@eldraco eldraco deleted the eldraco-patch-doc-fides-2 branch April 28, 2026 08:42
@github-project-automation github-project-automation Bot moved this from Todo to Done in Slips Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Related to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants