From e5e3cace05f1758f5acad43f82b4d30e67602372 Mon Sep 17 00:00:00 2001 From: Leonardo Schwarz Date: Fri, 16 Aug 2024 09:41:38 +0200 Subject: [PATCH] docs --- docs/contribute.md | 2 +- docs/good_to_know.md | 5 +++++ mkdocs.yml | 4 ++++ pyproject.toml | 3 ++- 4 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/contribute.md b/docs/contribute.md index d8027307..5cdce50a 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -1,4 +1,4 @@ -# Contribute +# Contributing This page describes some information relevant for contributing to bfabricPy. diff --git a/docs/good_to_know.md b/docs/good_to_know.md index 0d4b0474..cae8a98b 100644 --- a/docs/good_to_know.md +++ b/docs/good_to_know.md @@ -2,6 +2,11 @@ ## Updating workunits with many associated resources +!!! note "Summary: Updating workunits and its associated resources" + 1. Set workunit state to `"processing"`. + 2. Update workunit and associated resources, as much as you need to. + 3. Set workunit state to `"available"`. + When updating large workunits, it's crucial to prevent state recomputation in B-Fabric by setting the workunit state to `"processing"` before making any changes. Failing to do so can lead to significant performance issues and complications, especially during iterative updates. diff --git a/mkdocs.yml b/mkdocs.yml index 5f5acf53..5d6e981e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,3 +10,7 @@ theme: features: - navigation.sections - navigation.instant +markdown_extensions: + - admonition +plugins: + - mkdocstrings diff --git a/pyproject.toml b/pyproject.toml index 3806c8b2..5fbd7805 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -44,7 +44,8 @@ dev = [ "nox", "uv", "mkdocs", - "mkdocs-material" + "mkdocs-material", + "mkdocstrings[python]", ] [project.urls]