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

Update Composition Functions content to v1beta1 #594

Merged
merged 15 commits into from
Oct 30, 2023

Commits on Oct 28, 2023

  1. Update Composition Functions content to v1beta1

    This updates all current documentation of Composition Functions in the
    master directory to reflect the new v1beta1 implementation.
    
    Signed-off-by: Nic Cope <nicc@rk0n.org>
    negz committed Oct 28, 2023
    Configuration menu
    Copy the full SHA
    9179d8c View commit details
    Browse the repository at this point in the history
  2. Use mostly lowercase f for functions

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    negz committed Oct 28, 2023
    Configuration menu
    Copy the full SHA
    de4d754 View commit details
    Browse the repository at this point in the history
  3. Document how to use composition functions

    I plan to use the same page to document how to write a composition
    function. I'll add that documenation in a future commit.
    
    Signed-off-by: Nic Cope <nicc@rk0n.org>
    negz committed Oct 28, 2023
    Configuration menu
    Copy the full SHA
    2e99350 View commit details
    Browse the repository at this point in the history
  4. Add support for Mermaid diagrams

    Per instructions from Hugo:
    https://gohugo.io/content-management/diagrams/#mermaid-diagrams
    
    The styling could probably be updated to be more in line with the rest
    of the docs, but this already looks better to me than the goat ASCII
    diagrams Hugo supports out of the box.
    
    Signed-off-by: Nic Cope <nicc@rk0n.org>
    negz committed Oct 28, 2023
    Configuration menu
    Copy the full SHA
    cb1f9d2 View commit details
    Browse the repository at this point in the history
  5. Add developer-focused documentation for functions

    This consists of two sections in the existing page:
    
    * How to write a function
    * How functions work
    
    The former is somewhat light, because I intend to add detailed guides
    for each language we support. It's hard to go too deep in this general
    documentation without using language-specific examples.
    
    Signed-off-by: Nic Cope <nicc@rk0n.org>
    negz committed Oct 28, 2023
    Configuration menu
    Copy the full SHA
    8c7231e View commit details
    Browse the repository at this point in the history
  6. Allow composition function jargon

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    negz committed Oct 28, 2023
    Configuration menu
    Copy the full SHA
    023893b View commit details
    Browse the repository at this point in the history
  7. Link to common functions

    We might want to update these to marketplace links once they're
    available.
    
    Signed-off-by: Nic Cope <nicc@rk0n.org>
    negz committed Oct 28, 2023
    Configuration menu
    Copy the full SHA
    1d1e21a View commit details
    Browse the repository at this point in the history
  8. Elaborate on testing functions

    In particular, elaborate on how to test a function that is under
    development.
    
    Signed-off-by: Nic Cope <nicc@rk0n.org>
    negz committed Oct 28, 2023
    Configuration menu
    Copy the full SHA
    7ff74de View commit details
    Browse the repository at this point in the history

Commits on Oct 30, 2023

  1. Fix SSA link

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    negz committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    c73dc6f View commit details
    Browse the repository at this point in the history
  2. Remove reference to xfn Helm values

    They no longer exist in v1.14
    
    Signed-off-by: Nic Cope <nicc@rk0n.org>
    negz committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    6ad29d1 View commit details
    Browse the repository at this point in the history
  3. Link to section on disabling beta functions

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    negz committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    a32fbb7 View commit details
    Browse the repository at this point in the history
  4. Copy edits from composition functions code review

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    
    Co-authored-by: Pete Lumbis <pete@upbound.io>
    negz and plumbis committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    f427bb1 View commit details
    Browse the repository at this point in the history
  5. Style Mermaid diagrams to match light/dark mode

    This could look better but it's a good start to make the diagrams match the light/dark theme.
    
    There is a bug in here that switching themes doesn't update the diagram (but it works on future loads)
    
    Signed-off-by: Nic Cope <nicc@rk0n.org>
    
    Co-authored-by: Pete Lumbis <pete@upbound.io>
    negz and plumbis committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    be78d93 View commit details
    Browse the repository at this point in the history
  6. Add end-to-end to Crossplane dictionary

    Signed-off-by: Nic Cope <nicc@rk0n.org>
    negz committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    6de0d71 View commit details
    Browse the repository at this point in the history
  7. Make Go link to go.dev

    Honestly mostly to workaround Vale thinking "Go." is a spelling mistake.
    
    Signed-off-by: Nic Cope <nicc@rk0n.org>
    negz committed Oct 30, 2023
    Configuration menu
    Copy the full SHA
    6524c67 View commit details
    Browse the repository at this point in the history