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

T6342: extend schema to handle documentation in xml #4292

Open
wants to merge 1 commit into
base: current
Choose a base branch
from

Conversation

rebortg
Copy link
Member

@rebortg rebortg commented Jan 8, 2025

Change summary

This PR adds support for structured documentation in interface definitions by extending the RELAX NG schema. The new docs element allows for better organized documentation with the following optional elements

<properties>
  <help>Container applications</help>
  <priority>450</priority>
  <docs>
    <headline>Containers</headline>
    <text>The VyOS container implementation is based on https://podman.io as a deamonless container engine.</text>
    <usageExample>
      set container name mysql-server image mysql:8.0
      set container name mysql-server image quay.io/mysql:8.0
    </usageExample>
    <hints type="danger">If a registry is not specified, Docker.io will be used...</hints>
  </docs>
</properties>

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes)
  • Migration from an old Vyatta component to vyos-1x, please link to related PR inside obsoleted component
  • Other (please describe):

Related Task(s)

https://vyos.dev/T6342

Related PR(s)

vyos/vyos1x-config#32

How to test / Smoketest result

Checklist:

  • I have read the CONTRIBUTING document
  • I have linked this PR to one or more Phabricator Task(s)
  • I have run the components SMOKETESTS if applicable
  • My commit headlines contain a valid Task id
  • My change requires a change to the documentation
  • I have updated the documentation accordingly

Copy link

github-actions bot commented Jan 8, 2025

👍
No issues in PR Title / Commit Title

Copy link

github-actions bot commented Jan 9, 2025

CI integration ❌ failed!

Details

CI logs

  • CLI Smoketests (no interfaces) ❌ failed
  • CLI Smoketests (interfaces only) ❌ failed
  • Config tests 👍 passed
  • RAID1 tests 👍 passed
  • TPM tests 👍 passed

@rebortg rebortg marked this pull request as ready for review January 9, 2025 13:25
@@ -2,19 +2,19 @@
<grammar xmlns="http://relaxng.org/ns/structure/1.0">
<!--
interface_definition.rnc: VyConf reference tree XML grammar

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please clean the stray whitespaces?

Copy link
Member Author

@rebortg rebortg Jan 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can fix it, but this is the generated output from the interface_definition.rnc file with:
trang interface_definition.rnc interface_definition.rng

how should i deal with it?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that we have a docker container and people don't have to install trang on their own machines, I wonder if we should even commit .rng files at all, or just generate them at build time. In any case, I think stray whitespace in autogenerated files is not an issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

4 participants