Review documentation regarding self-managed package registry #1287
Conversation
Starting on 7.16 we are going to officialy support self-managed package registry deployments for air-gapped environments. Update documentation referring to this feature.
|
A documentation preview will be available soon: |
| @@ -388,7 +388,7 @@ The following table shows a comparison of capabilities supported by {beats} and | |||
| |{y} | |||
| |{n} | |||
| |{y} | |||
| |The Integrations app requires a network connection to the {fleet-guide}/fleet-overview.html#package-registry-intro[Elastic Package Registry]. We are considering an https://github.com/elastic/integrations/issues/1178[on-prem version of EPR]. {fleet}-managed {agent}s require a connection to our artifact repository for agent binary upgrades. These are not required for standalone {agent}s or {beats}. | |||
| |The Integrations app requires a network connection to the {fleet-guide}/fleet-overview.html#package-registry-intro[{package-registry}], or a {integrations-developer-guide}/air-gapped.html#air-gapped-diy-epr[self-managed deployment of the {package-registry}]. {fleet}-managed {agent}s require a connection to our artifact repository for agent binary upgrades. These are not required for standalone {agent}s or {beats}. | |||
There was a problem hiding this comment.
I couldn't find a way to link to the air-gapped page. I tried these formats:
<<air-gapped>>(I guess this doesn't work because this is in a different guide){integrations}/air-gapped.html[]{integrations-developer-guide}/air-gapped.html[]
How could I define a link to this page?
I also wonder if this page should be moved to the ingest-management guide, as is not so related to integrations development.
There was a problem hiding this comment.
Ah I see the problem. We don't have an attribute for this book in our shared attributes file yet. I've opened a PR here to add it: elastic/docs#2298
However, I don't think the air gapped docs should live in the integrations developer guide. Users need to know this info, too. I would move it to the Fleet and Elastic Agent Guide, probably under https://www.elastic.co/guide/en/fleet/7.16/integrations.html.
There was a problem hiding this comment.
So once that PR is merged, you would use: {integrations-devguide}/filename.html[Topic name]
There was a problem hiding this comment.
I have tried to move the page, and now there are broken links, should I leave some kind of placeholder (or redirect)? in the old page?
There was a problem hiding this comment.
Thanks for the help btw! 🙂
| @@ -388,7 +388,7 @@ The following table shows a comparison of capabilities supported by {beats} and | |||
| |{y} | |||
| |{n} | |||
| |{y} | |||
| |The Integrations app requires a network connection to the {fleet-guide}/fleet-overview.html#package-registry-intro[Elastic Package Registry]. We are considering an https://github.com/elastic/integrations/issues/1178[on-prem version of EPR]. {fleet}-managed {agent}s require a connection to our artifact repository for agent binary upgrades. These are not required for standalone {agent}s or {beats}. | |||
| |The Integrations app requires a network connection to the {fleet-guide}/fleet-overview.html#package-registry-intro[{package-registry}], or a {integrations-developer-guide}/air-gapped.html#air-gapped-diy-epr[self-managed deployment of the {package-registry}]. {fleet}-managed {agent}s require a connection to our artifact repository for agent binary upgrades. These are not required for standalone {agent}s or {beats}. | |||
There was a problem hiding this comment.
Ah I see the problem. We don't have an attribute for this book in our shared attributes file yet. I've opened a PR here to add it: elastic/docs#2298
However, I don't think the air gapped docs should live in the integrations developer guide. Users need to know this info, too. I would move it to the Fleet and Elastic Agent Guide, probably under https://www.elastic.co/guide/en/fleet/7.16/integrations.html.
| @@ -388,7 +388,7 @@ The following table shows a comparison of capabilities supported by {beats} and | |||
| |{y} | |||
| |{n} | |||
| |{y} | |||
| |The Integrations app requires a network connection to the {fleet-guide}/fleet-overview.html#package-registry-intro[Elastic Package Registry]. We are considering an https://github.com/elastic/integrations/issues/1178[on-prem version of EPR]. {fleet}-managed {agent}s require a connection to our artifact repository for agent binary upgrades. These are not required for standalone {agent}s or {beats}. | |||
| |The Integrations app requires a network connection to the {fleet-guide}/fleet-overview.html#package-registry-intro[{package-registry}], or a {integrations-developer-guide}/air-gapped.html#air-gapped-diy-epr[self-managed deployment of the {package-registry}]. {fleet}-managed {agent}s require a connection to our artifact repository for agent binary upgrades. These are not required for standalone {agent}s or {beats}. | |||
There was a problem hiding this comment.
So once that PR is merged, you would use: {integrations-devguide}/filename.html[Topic name]
There was a problem hiding this comment.
@dedemorton I think I have addressed all your comments, could you please take another look?
| ifeval::["{release-state}"=="unreleased"] | ||
| [WARNING] | ||
| ==== | ||
| Version {version} of the {package-registry} distribution has not yet been released. | ||
| ==== | ||
| endif::[] |
There was a problem hiding this comment.
@dedemorton this warning doesn't appear in the CI build https://observability-docs_1287.docs-preview.app.elstc.co/guide/en/fleet/master/air-gapped.html#air-gapped-diy-epr
Is this expected? or something is wrong here?
There was a problem hiding this comment.
Oh that's my fault! If you look at the index.asciidoc file, you'll see:
//TODO: Remove release-state override before merging
:release-state: released
This setting overrides the setting for the branch specified here.
The override is there so that reviewers can see all the content. You can remove the override in index.asciidoc or comment it out.
…#1287) Starting on 7.16 we are going to officialy support self-managed package registry deployments for air-gapped environments. Update documentation referring to this feature.
…#1287) Starting on 7.16 we are going to officialy support self-managed package registry deployments for air-gapped environments. Update documentation referring to this feature. # Conflicts: # docs/en/integrations/air-gapped.asciidoc
…1317) Starting on 7.16 we are going to officialy support self-managed package registry deployments for air-gapped environments. Update documentation referring to this feature. # Conflicts: # docs/en/integrations/air-gapped.asciidoc
…#1287) Starting on 7.16 we are going to officialy support self-managed package registry deployments for air-gapped environments. Update documentation referring to this feature.
Starting on 7.16 we are going to officialy support self-managed package
registry deployments for air-gapped environments. Update documentation
referring to this feature.