search

elastic / observability-docs

Elastic Observability Documentation
Other
33 stars 161 forks source link

package-spec: support multiple package types #1861

Open mtojek opened 2 years ago

mtojek commented 2 years ago

With recent changes in the package-spec, we're planning to extend it with another package type. With this PR I hardcoded to the current type we support, integration, but we need to prepare the room for potentially more types.

mtojek commented 2 years ago

@gtback FYI about works around this topic.

gtback commented 2 years ago

Hi @mtojek, sorry but I'm not sure I understand exactly what you're asking for as far as the Docs build goes. I know there are scripts that transform the package specifications into appropriate Asciidoc documentation, but as far as I know, none of that logic is part of this repo; we just build all the Asciidoc that is either manually-written docs or auto-generated specifications. Am I missing something?

If you're trying to set up redirects to pages that include integrations in the URL, I can help with that if you give me a list of the old and new URLs, or a rule for transforming one to another.

bmorelli25 commented 2 years ago

Hey @mtojek. I'm digging into this and it looks like the package-spec include statements updated in https://github.com/elastic/observability-docs/pull/1818 are for this page: https://www.elastic.co/guide/en/integrations-developer/current/package-spec.html. In order to support docs for more types, we'd just need to add new documentation with new includes. I don't see anything in the legacy doc build that needs to be updated.

mtojek commented 2 years ago

We may consider introducing a more sophisticated logic in spec to share common parts of it between types. We will keep you posted, so far it's a future story (PR comment).

bmorelli25 commented 1 year ago

Following up on old issues and it looks like https://github.com/elastic/package-spec/issues/319 was merged so we can move forward with this issue.