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.

Sign up for GitHub

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

Fix deployment readme links #15667

Merged
merged 1 commit into from
Dec 16, 2024
Merged

Fix deployment readme links #15667

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions deployment/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ deployment/configuration logic to be tested against ephemeral environments
and then exposed for use in persistent environments like testnet/mainnet.

## Table of Contents
- [Address Book](##Address-Book)
- [View](##View)
- [Environment](##Environment)
- [Job Distributor](##Job-Distributor)
- [Changesets](##Changesets)
- [Directory Structure](##Directory-Structure)
- [Integration Testing](##Integration-Testing)
- [FAQ](##FAQ)
- [Address Book](#address-book)
- [View](#view)
- [Environment](#environment)
- [Job Distributor](#job-distributor)
- [Changesets](#changsets)
- [Directory Structure](#directory-structure)
- [Integration Testing](#integration-testing)
- [FAQ](#faq)

## Address Book
An [address book](https://github.com/smartcontractkit/chainlink/blob/develop/deployment/address_book.go#L79) represents
Expand Down Expand Up @@ -100,14 +100,14 @@ TODO: Add various examples in deployment/example.
contracts (like MCMS, LinkToken etc) which can be shared
by products.

/deployment/<product>/internal
/deployment/product/internal
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought the <product> is good indication to users that it is a placeholder?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue is it renders like /deployment//internal

- Internal building blocks for changesets

/deployment/<product>/view
/deployment/product/view
- Hold readonly mappings Go bindings to json marshallable objects.
- Used to generate a view of the system.

/deployment/<product>/changeset
/deployment/product/changeset
- Think of this as the public API for deployment and configuration
of your product.
- All the changesets should have an associated test using a memory or devenv
Expand Down
Loading