Redfish-Tools icon indicating copy to clipboard operation
Redfish-Tools copied to clipboard

Doc generator: Link to DMTF/Redfish repo mentionned in README_config_files.md ?

Open donzef opened this issue 2 years ago • 4 comments

The doc-generator/README_config_files.md asks to clone the DMTF/Redfish repo in order to be able to use the provided json-schema input directory.

Would it be possible to provide a link to that DMTF/Redfish repo ? So we can use provided examples as-is.

Thanks.

image

donzef avatar Jul 26 '22 14:07 donzef

Unfortunately that's a private repository only accessible to members of the organization. We shouldn't have any examples in here that reference it. We'll need to clean this up to decouple things.

mraineri avatar Jul 26 '22 15:07 mraineri

Agreed - that README needs to be updated to remove that reference, and provide more explicit instructions to set up the equivalent. Essentially, you just need the /json-schema folder from DSP8010 copied locally and referenced in the config file. The only other thing that would be needed to replicate the contents of DSP2046 / DSP0268 are the "example payload" files. Those are not currently published, but I will suggest to the group that we include those in future public release bundles.

jautor avatar Jul 26 '22 15:07 jautor

Thanks for the tips. I bumped into DSP2046 file not found errors and, if I remember correctly, I bumped also into a mockup or mockups file not found.... So, yes, it would be good to have a valid json-schema directory somewhere in the Redfish-Tools repo.

donzef avatar Jul 26 '22 15:07 donzef

Could you please make DSP2046-examples folder public too? It is required by the "standard_html" sample.

kriegeraa avatar Oct 11 '22 16:10 kriegeraa