Skip to main content

RFC like documents management tool

Project description

rfcctl: RFC like document manager

&cop; 2023 SiLeader.

How to use

1. Add context

Add context to use context add subcommand.

rfcctl context add --name <CONTEXT_NAME> --user <USER NAME> /path/to/directory
  • --name is context name alias
  • --user is writer username
  • --switch option is switch this context as default context
  • --initial-status is RFC's initial status. default is Draft
  • --obsoleted-status is obsoleted RFC's status. default is Obsoleted
  • --init option is create skeleton.md in this directory

2. Create new RFC

Create new RFC file from skeleton.md to use create subcommand.

rfcctl create --category-tree <CATEGORY> <SUBCATEGORY in CATEGORY> ... --title 'My new RFC'

3. Update RFC metadata

Update RFC's obsoleted metadata to use update subcommand.

rfcctl update

License

Apache License 2.0

See LICENSE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rfcctl-0.1.0.tar.gz (10.7 kB view hashes)

Uploaded Source

Built Distribution

rfcctl-0.1.0-py3-none-any.whl (12.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page