question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Support configuration inside needflow

See original GitHub issue

As of now, needflow provides configuration inside “needs_flow_configs”. This is not sufficient especially when aligning and positioning different need flow elements for rendering.

Eg: In the example below

.. needflow:: Title
   :link_types: 
   :show_link_names:
   :config: toptobottom,cplant   
   :show_legend:
   :align: center

There is no way to position the need elements in a definite order or place. Also, there is no way to define the direction of each puml element.

This results in unorganized rendered elements.

Issue Analytics

  • State:open
  • Created a year ago
  • Comments:5 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
twodropscommented, Sep 30, 2022

What purpose are you using needflow for? As the name suggests it is for showing the relation between need objects only. For everything else, you will have to use needuml as @danwos suggested.

Another tip would be to keep the scope of each ‘needflow’ small by using filters or using filter functions. It is not really meant to visualize 100s of need objects in one diagram, but rather partition your scope and create smaller diagrams. For larger reporting, I would import needs.json and use an external reporting tool like Splunk, Grafana etc. which could offer you more dynamic visualization, filtering etc.

1reaction
danwoscommented, Sep 30, 2022

For 2): No, no postprocessing is available. needflow generates a PlantUML string only. It knows nothing about the PlantUML data model or has access to it. So each postprocessing would have access to the overall generated string only, which may have 10-200 lines. You can see the output when using the :debug: flag.

For 1): Maybe, but it would be link-type based and affects all needs using this link type. Have a look into our need_etra_links style docs.

You could set it like this:

needs_extra_links = [
   {
      "option": "tests",
      "incoming": "is tested by",
      "outgoing": "tests",
      "copy": False,
      "style_start": "<-",
      "style_end": "left-->",  # Direction added
   }

But I’m not sure if this is really helpful.

However, all we can do is give you the possibility to write your own PlantUML code and use the mechanism of PlantUML. This is done by needuml, which has also access to all need-data and allows to write filter-own logics by using Jinja.

Read more comments on GitHub >

github_iconTop Results From Across the Web

needflow - Sphinx-Needs 1.1.0 documentation
needflow supports the full filtering possibilities of Sphinx-Needs. ... You can configure it globally by setting needs_flow_show_links in conf.py. Example.
Read more >
Issues · useblocks/sphinx-needs - GitHub
needs.json shall contain/support images and co. ... ProTip! Find all open issues with in progress development work with linked:pr. Footer.
Read more >
HELP! Need FLOW for an organizational hierachy bas... - Power ...
Hi, I work at an enterprise which use Office 365 Ent. edition, so we have access to all the relevant apps ( except...
Read more >
Sphinx-Needs: Docs-as-Code based Life cycle management
It is designed to support developers during documentation creation and allows to automate and configure most tasks to fulfill company internal processes and ......
Read more >
Configure Approval To-do / Task Information - ServiceNow
OOTB "Approve Request" has some fields to display in To-do Widget "HRM Todos Summary". To-dos-Employee-Service-Center.png. It displays ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found