[Docs] Monodocs: add configuration to show tag/release in the monodocs build output

[cosmicBboy]

Description

The purpose of this task is to make the monodocs build process more transparent by showing the git tag and commit associated with the flytekit, flytesnacks, and flytectl repos when the monodocs are built.

Are you sure this issue hasn't been raised already?

• Yes

Have you read the Code of Conduct?

• Yes

[dosubot]

🤖

Hello @cosmicBboy! 👋

I'm Dosu, a friendly bot here to assist you while we wait for a human maintainer. I can help you solve bugs, answer questions, and guide you to become a contributor. Looking forward to working with you! 😊

Yes, it is possible to add a configuration to the monodocs build process to specify a specific tag when cloning the flytekit, flytesnacks, and flytectl repositories for their documentation content. This can be achieved by modifying the import_projects list in the docs/conf.py file.

Each dictionary in the import_projects list represents a project to be cloned. The source key specifies the repository to be cloned. If you want to clone a specific tag, you can append the tag to the repository URL. For example, to clone the v0.1.0 tag of the flytekit repository, you can change the source from "https://github.com/flyteorg/flytekit" to "https://github.com/flyteorg/flytekit.git#v0.1.0".

Here is how you can modify the import_projects list to clone specific tags:

import_projects = [
    {
        "source": flytesnacks_local_path or "https://github.com/flyteorg/flytesnacks.git#<tag>",
        "docs_path": "docs",
        "dest": "flytesnacks",
        "cmd": [
            ["cp", "-R", f"{flytesnacks_path}/examples", "./examples"],
            [
                # remove un-needed docs files in flytesnacks
                "rm",
                "-rf",
                "flytesnacks/jupyter_execute",
                "flytesnacks/auto_examples",
                "flytesnacks/_build",
                "flytesnacks/_tags",
            ]
        ],
        "local": flytesnacks_local_path is not None,
    },
    {
        "source": flytekit_local_path or "https://github.com/flyteorg/flytekit.git#<tag>",
        "docs_path": "docs/source",
        "dest": "api/flytekit",
        "cmd": [
            ["mkdir", "-p", import_projects_config["flytekit_api_dir"]],
            ["cp", "-R", f"{flytekit_path}/flytekit", import_projects_config["flytekit_api_dir"]],
            ["cp", "-R", f"{flytekit_path}/plugins", import_projects_config["flytekit_api_dir"]],
            ["cp", "-R", f"{flytekit_path}/tests", "./tests"],
        ],
        "local": flytekit_local_path is not None,
    },
    {
        "source": flytectl_local_path or "https://github.com/flyteorg/flytectl.git#<tag>",
        "docs_path": "docs/source",
        "dest": "flytectl",
        "local": flytectl_local_path is not None,
    },
    {
        "source": "../flyteidl",
        "docs_path": "protos",
        "dest": "protos",  # to stay compatible with flyteidl docs path naming
        "cmd": ["cp", "../flyteidl/README.md", "protos/README.md"],
        "local": True,
    }
]

Replace <tag> with the tag you want to clone. You can find more details in the docs/conf.py file.

Sources

• docs/conf.py
• script/generate_config_docs.sh

---

This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.

[cosmicBboy]

fixed by: d5f0002