You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@buildstream.apache.org by "juergbi (via GitHub)" <gi...@apache.org> on 2026/05/08 16:20:22 UTC

[PR] docs: Move BuildElement's "Built-in functionality" to a new page [buildstream]

juergbi opened a new pull request, #2122:
URL: https://github.com/apache/buildstream/pull/2122

   The documentation of how to use the common features provided by the `BuildElement` base class is currently part of the API reference even though it's more relevant to project authors than plugin developers.
   
   This moves that section to a new page in the "Reference" section, next to other plugin-specific documentation.
   
   The main content of the new page is unchanged but I've tweaked the initial paragraphs to make sense with the structure change.
   
   This is a replacement for #2103 with proper links and TOC entry (a bit quirky with Sphinx but I think it looks and works reasonably well now).


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@buildstream.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] docs: Move BuildElement's "Built-in functionality" to a new page [buildstream]

Posted by "juergbi (via GitHub)" <gi...@apache.org>.
juergbi merged PR #2122:
URL: https://github.com/apache/buildstream/pull/2122


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@buildstream.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] docs: Move BuildElement's "Built-in functionality" to a new page [buildstream]

Posted by "juergbi (via GitHub)" <gi...@apache.org>.
juergbi commented on code in PR #2122:
URL: https://github.com/apache/buildstream/pull/2122#discussion_r3282522244


##########
doc/source/core_plugins.rst:
##########
@@ -27,8 +27,21 @@ given element specify their plugin specific configuration directly
 
 Elements
 --------
+
+ * :doc:`elements/stack`
+ * :doc:`elements/import`
+ * :doc:`elements/compose`
+ * :doc:`elements/script`
+ * :doc:`elements/link`
+ * :doc:`elements/junction`
+ * :doc:`elements/filter`
+ * :doc:`Build Elements <core_buildelement>`

Review Comment:
   Yes, it doesn't seem ideal, but it's the best I could come up with and should definitely still be more discoverable than the status quo. If we can think of a better solution in the future, we can improve it further.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@buildstream.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] docs: Move BuildElement's "Built-in functionality" to a new page [buildstream]

Posted by "juergbi (via GitHub)" <gi...@apache.org>.
juergbi commented on PR #2122:
URL: https://github.com/apache/buildstream/pull/2122#issuecomment-4408025963

   From https://github.com/apache/buildstream/pull/2103#pullrequestreview-3897891844 (@tmewett):
   > My 2c: the main issue I have is that BuildElement is an API name, and if we're trying to document this for users it might make sense to frame this in a different way.
   
   I've linked the new page as "Build Elements" in the TOC and tried to make the intro paragraph a bit more understandable for project authors. If you have any suggestions how to further improve that, please let me know.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@buildstream.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] docs: Move BuildElement's "Built-in functionality" to a new page [buildstream]

Posted by "abderrahim (via GitHub)" <gi...@apache.org>.
abderrahim commented on code in PR #2122:
URL: https://github.com/apache/buildstream/pull/2122#discussion_r3282401693


##########
doc/source/core_plugins.rst:
##########
@@ -27,8 +27,21 @@ given element specify their plugin specific configuration directly
 
 Elements
 --------
+
+ * :doc:`elements/stack`
+ * :doc:`elements/import`
+ * :doc:`elements/compose`
+ * :doc:`elements/script`
+ * :doc:`elements/link`
+ * :doc:`elements/junction`
+ * :doc:`elements/filter`
+ * :doc:`Build Elements <core_buildelement>`

Review Comment:
   This feels a bit hidden here, but I can't think of a better place to put it.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@buildstream.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org