Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a documentaiton system #3

Open
LecrisUT opened this issue Sep 21, 2023 · 0 comments
Open

Add a documentaiton system #3

LecrisUT opened this issue Sep 21, 2023 · 0 comments

Comments

@LecrisUT
Copy link
Contributor

For now the format would be plain markdown so that it is imported in packit.dev documentation. Template format is inspired from cmake's documentation:

# Title

<!-- SPHINX-START -->

Short description

## Synopsis
```
plans:
  import:
    url: https://github.com/packit/tmt-plans
    ref: main
    name: /plans/name-of-plan
```

## Options

`NAME_OF_ENV_INPUT` [Default: `some_value`]
  Details about option

## Examples

## See Also

<!-- SPHINX-END -->
  • Synopsis is to make way when there is a clear way to interact with the imported plans
  • Might also consider stories to be consistent with tmt's backend. Should be simple to move back-and-forth with a consistent documentation format. The only issue is that the documentation is not visible unless on the external site. Could make an action to generate and keep them in sync.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant