Merge branch 'kayode-dev' of https://github.com/kayodegigz/packit.dev into kayode-dev

Author: kayodegigz

docs/cli/validate-config.md docs/cli/config/validate.mddocs/cli/validate-config.md renamed to docs/cli/config/validate.md

@@ -1,16 +1,16 @@
 ---
-title: validate-config
+title: validate
 date: 2021-03-18T08:48:36+01:00
 sidebar_position: 30
 ---
-# `packit validate-config`
+# `packit config validate`
 
 Validate the Packit configuration file.
 
 
 ## Help
 
-    Usage: packit validate-config [OPTIONS] [PATH_OR_URL]
+    Usage: packit config validate [OPTIONS] [PATH_OR_URL]
 
       Validate PackageConfig.
 

docs/cli/index.md

@@ -99,7 +99,7 @@ configuration files, like in the following examples:
 * [srpm](/docs/cli/srpm/)
 * [status](/docs/cli/status)
 * [sync-from-downstream](/docs/cli/sync-from-downstream/)
-* [validate-config](/docs/cli/validate-config)
+* [config validate](/docs/cli/config/validate)
 * [source-git init](/docs/cli/source-git/init)
 * [source-git update-dist-git](/docs/cli/source-git/update-dist-git)
 * [source-git update-source-git](/docs/cli/source-git/update-source-git)

docs/configuration/downstream_configuration_template.md

@@ -10,7 +10,7 @@ This is a template for configuration of Packit's Fedora release automation (dist
 2. create a `packit.yaml`/`.packit.yaml` file in root directory of your dist-git repository in your `rawhide` branch
 and paste the content
 3. resolve the TODOs
-4. (optionally) run [`packit validate-config`](/docs/cli/validate-config) to make sure the configuration is valid
+4. (optionally) run [`packit config validate`](/docs/cli/config/validate) to make sure the configuration is valid
 
 ## Template
 ```yaml

docs/configuration/examples.md

@@ -22,7 +22,7 @@ or with a command from `rpm-build` package that will honor the macros:
 
 ```yaml
 get-current-version:
-  - rpmspec -q --queryformat "%{VERSION}\n" *spec |head -n1
+  - rpmspec -q --queryformat "%{VERSION}\n" --srpm *spec
 ```
 
 </details>

docs/configuration/index.md

@@ -344,7 +344,7 @@ files_to_sync:
 
 :::info
 
-This option is a successor to `synced_files` that has been already deprecated.
+This option is a successor to `synced_files` that has been deprecated and removed.
 
 :::
 
@@ -667,7 +667,7 @@ only one of these options.
 (*dict*) Macros to be explicitly defined or undefined at spec file parse time.
 To undefine a macro, set its value to `null`.
 This can be useful for instance when the spec file is OS-specific and Packit runs on a different OS
-(Packit Service currently runs on CentOS Stream 9).
+(Packit Service currently runs on Fedora 41).
 
 For example, `%cargo_prep` macro used in Rust packages accepts `-V` option on EL but not on Fedora.
 To make sure Packit is able to parse a spec file that uses `%cargo_prep -V` on both OSes,
@@ -787,28 +787,30 @@ We will be happy for any feedback regarding it, [please contact us](https://gith
 (*string*) An option to set arguments of `csmock` (the tool used inside [OpenScanHub](https://openscanhub.fedoraproject.org/)). For instance, you can specify arguments like `--cppcheck-add-flag=--enable=style` to check styling issues as seen in [this example run](https://openscanhub.fedoraproject.org/task/10066/) triggered from [this](https://github.com/avahi/avahi/pull/641) testing pull-request on Avahi.
 
 #### osh_options
-A set of additional options passed into osh-cli for additional functionality
+
+A set of additional options passed to `osh-cli` for additional customizations of the functionality.
+
 ##### analyzer
-(*string*) 
-list of analyzers to be passed to osh-cli use comma as a separator: e.g. "analyzer:gcc,clang,cppcheck"
+
+(*string*) List of analyzers to be passed to `osh-cli`. Use comma as a separator, e.g. `gcc,clang,cppcheck`.
 
 ```yaml
 osh_options:
   analyzer: "gcc, shellcheck"
 ```
 
 ##### config
-(*string*) 
-Used to specify mock config name to be passed to osh-cli. If value is not set in yaml file, default value "fedora-rawhide-x86_64" is used.
+
+(*string*) Used to specify mock config name to be passed to `osh-cli`. If value is not set in the config, default value `"fedora-rawhide-x86_64"` is used.
 
 ```yaml
 osh_options:
   config: "fedora-rawhide-x86_64"
 ```
 
 ##### profile
-(*string*) 
-Used to specify predefined scanning profile to be passed to osh cli.
+
+(*string*) Used to specify predefined scanning profile to be passed to `osh-cli`.
 
 ```yaml
 osh_options:

docs/fedora-releases-guide/dist-git-onboarding.md

@@ -52,7 +52,7 @@ Packit dist-git configuration.
 :::tip Configuration validation
 
 For validation of the configuration, you can utilise
-Packit CLI command [`validate-config`](/docs/cli/validate-config) or our 
+Packit CLI command [`config validate`](/docs/cli/config/validate) or our 
 [pre-commit hooks](/posts/pre-commit-hooks#validate-config).
 
 :::

docs/fedora-releases-guide/what-to-know.md

@@ -68,7 +68,7 @@ During service outages, maintain workflow using Packit CLI:
 2. [Configure required tokens](https://packit.dev/docs/configuration#user-configuration-file)
 3. Verify setup (if not already working in service):
    - Follow [dist-git onboarding guide](https://packit.dev/docs/fedora-releases-guide/dist-git-onboarding)
-   - Validate config with `packit validate-config`
+   - Validate config with `packit config validate`
 
 #### Troubleshooting Issues
 

docs/guide.md

@@ -246,7 +246,7 @@ For downstream jobs, Packit always loads the config from the default branch of t
 :::tip 
 
 For validation of the configuration, you can utilise
-Packit CLI command [`validate-config`](/docs/cli/validate-config) or our 
+Packit CLI command [`config validate`](/docs/cli/config/validate) or our 
 [pre-commit hooks](/posts/pre-commit-hooks#validate-config).
 
 :::

posts/pre-commit-hooks/index.md

@@ -46,7 +46,7 @@ To try, add this to your `.pre-commit-config.yaml`
 
 Packit uses a [YAML configuration file](https://packit.dev/docs/configuration)
 in an upstream repository.
-We have a [packit validate-config](https://packit.dev/docs/cli/validate-config) command
+We have a [packit config validate](https://packit.dev/docs/cli/config/validate) command
 to check it, but it's easy to forget (to run it) and notice a typo after you
 committed and pushed the changes and waited for some time for Packit to tell you
 that in a PR.
@@ -57,7 +57,7 @@ It's much faster to catch the problem before committing and/or pushing the chang
 
 This hook runs (only if there's been a change in the `.packit.yaml`)
 `packit` in a container (from [our image](https://quay.io/repository/packit/packit)),
-mounts your sources inside and runs the `packit validate-config`.
+mounts your sources inside and runs the `packit config validate`.
 
 ```yaml
 - repo: https://github.com/packit/pre-commit-hooks