Skip to content

Conversation

@osfameron
Copy link
Collaborator

@osfameron osfameron commented Jun 13, 2023

To simplify process for Analytics team, we can use https://gitlab.com/antora/antora-collector-extension/

NOTE: this extension is currently Alpha, will have to discuss with OpenDevise.

This PR will add the Couchbase fork of AsterixDB and the Collector extension.
A subsequent PR on the AsterixDB repo will provide a command to aggregate sources.
couchbase/asterixdb#2

The .adoc file in this PR includes one of these files, using the Markdown block (modified to cope with the use of HTML in AsterixDB sources)

To simplify process for Analytics team, we can use
https://gitlab.com/antora/antora-collector-extension/

NOTE: this extension is currently Alpha, will have to discuss
with OpenDevise.

This PR will add the Couchbase fork of AsterixDB and the Collector
extension.
A subsequent PR on the AsterixDB repo will provide a command to
aggregate sources.

The .adoc file in this PR includes one of these files, using the
Markdown block (modified to cope with the use of HTML in AsterixDB
sources)
@osfameron osfameron requested review from leeming and simon-dew June 13, 2023 14:15
osfameron added a commit to osfameron/asterixdb that referenced this pull request Jun 13, 2023
See couchbase/docs-site#699

This extension uses the config in antora.yml to call
getafix.sh and copy relevant sources into a modules/
structure.

(This is POC, so I've just copied some random sources)
@osfameron
Copy link
Collaborator Author

@mojavelinux I've wanted to test this extension out for a while since @RayOffiah mentioned it, but was blocked on the Antora 3.1 upgrade.
This POC was much easier than expected, this is a really powerful feature for exactly this kind of issue (3rd party repos where we have minimal control over the content structure.)

I've raised one minor issue on GitLab -- which may just be a bad expectation on my part.

The extension is currently marked Alpha. Do you recommend that we proceed beyond this initial demo to a fully fleshed out POC?

@mojavelinux
Copy link
Contributor

mojavelinux commented Jun 13, 2023

The extension is currently marked Alpha. Do you recommend that we proceed beyond this initial demo to a fully fleshed out POC?

I would be cautious. Alpha means that the extension could change at any time and that we might even completely redesign it. There are no guarantees. However, if you're prepared for a potential migration in the future, then you can use the version that is released and either stay with that or do any necessary migration when 1.0.0 is available.

@osfameron
Copy link
Collaborator Author

OK. Assuming that we're using the package as intended, then it feels like even a substantial redesign should be manageable with a reasonable effort (update configuration, update paths, change how the command payload is called etc.)

I'm ok with that from tooling side, @simon-dew what do you think as stakeholder?

@osfameron osfameron closed this Apr 30, 2025
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.

2 participants