search

screwdriver-cd / screwdriver

An open source build platform designed for continuous delivery.
http://screwdriver.cd
Other
1.01k stars 169 forks source link

Bookends Documentation/Discovery #735

Open tkyi opened 7 years ago

tkyi commented 7 years ago

Is this a BUG REPORT or FEATURE REQUEST? (choose one): Documentation/Feature request

There is currently no documentation for how to create your own bookend in http://docs.screwdriver.cd. It would be nice to have the information provided in https://github.com/screwdriver-cd/build-bookend also available in the guide.

There is also no way to easily discover what each bookend does and what is available. It might be nice to have a bookend discovery feature, much like https://github.com/screwdriver-cd/screwdriver/issues/522.

petey commented 7 years ago

I think there's a lot of room for improvement for both bookends and shared steps (commands) in this space. We should probably step back and take another look at the implementation of bookends in general.

tkyi commented 7 years ago

@petey I don't disagree, but if we're not going to work on making changes immediately, I think it'd be valuable to at least add documentation in the guide in the meantime.