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

package-spec: support multiple package types #1861

Open
mtojek opened this issue Apr 26, 2022 · 5 comments
Open

package-spec: support multiple package types #1861

mtojek opened this issue Apr 26, 2022 · 5 comments
Labels
Team:Docs Label for the Observability docs team

Comments

@mtojek
Copy link
Contributor

mtojek commented Apr 26, 2022

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 mtojek added the Team:Docs Label for the Observability docs team label Apr 26, 2022
@mtojek
Copy link
Contributor Author

mtojek commented May 4, 2022

@gtback FYI about works around this topic.

@gtback
Copy link
Member

gtback commented May 9, 2022

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
Copy link
Member

bmorelli25 commented May 9, 2022

Hey @mtojek. I'm digging into this and it looks like the package-spec include statements updated in #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.

@bmorelli25 bmorelli25 transferred this issue from elastic/docs May 9, 2022
@mtojek
Copy link
Contributor Author

mtojek commented May 10, 2022

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
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Docs Label for the Observability docs team
Projects
None yet
Development

No branches or pull requests

3 participants