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

[DOC] configuration.rst #827

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

Conversation

kaystrobach
Copy link

  • fix broken xsd uri
  • change not allowed html-theme to theme

* fix broken xsd uri
* change not allowed html-theme to theme
Copy link
Contributor

@linawolf linawolf left a comment

Choose a reason for hiding this comment

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

Thanks a lot for your contribution! Actually the xsi:schemaLocation does not have to be an URI and currently points to a the local directory when using the mono-repository. Did you have trouble with it working in your IDE?

About the the attribute html-theme vs theme you are correct, thanks for catching it!

@kaystrobach
Copy link
Author

Yep, did not work do fetch the xsd, as we do not use the vendor folder in that project. I would prefer to have the xsd centrally stored. This way you can validate it even without the dependencies installed.

@linawolf
Copy link
Contributor

I think we had that discussion before and descided for some reason to use relative URLs, can you remember why, @jaapio ?

@garvinhicking
Copy link
Contributor

IIRC the main reason was that we figured the XSD would be changed around and we didn't have a URI where the XSD would be published already (and would maybe need release versioning).

For a 1.0 release we should really provide a stable URI somewhere. Maybe if we bundle it within the documentation of render-guides and use that "main" version as a stable link?!

@kaystrobach
Copy link
Author

The uri should contain a version number.

@garvinhicking
Copy link
Contributor

What's the best practice here if the XSD is in another repository, where the release versions don't reflect changes in the xsd itself (i.e. version 2.3.0 of the package uses the same xsd as in version 0.3.0 - so we have new package versions without the xsd changing.
And if the xsd would get a new attribute in version 3.0 of the package that we don't use though, we would need to remember changing all xsd URIs in our docs?

Probably we need to add the xsd to our own domain because of this (=copy it into our own render-guidey repo)?

@kaystrobach
Copy link
Author

Imho the xsd is a technical description. It should only have mayors as versions. Maybe exceptions for lower versions until 1.0

Maybe you also have „latest“ which can be used in the docs. 🤷‍♂️

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

Successfully merging this pull request may close these issues.

3 participants