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

Jump to bottom

docs: remove headings from method doc #30965

Merged
merged 2 commits into from
Jul 31, 2024
Merged

docs: remove headings from method doc #30965

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30beb1a
remove headings from method doc
nicolaracco Jul 28, 2024
ff5ff8a
Merge branch 'main' into fix-doc-heading
mergify[bot] Jul 31, 2024
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
6 changes: 2 additions & 4 deletions packages/aws-cdk-lib/core/lib/stack.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1171,8 +1171,6 @@ export class Stack extends Construct implements ITaggable {
* remove the reference from the consuming stack. After that, you can remove
* the resource and the manual export.
*
* ## Example
*
* Here is how the process works. Let's say there are two stacks,
* `producerStack` and `consumerStack`, and `producerStack` has a bucket
* called `bucket`, which is referenced by `consumerStack` (perhaps because
Expand All @@ -1183,7 +1181,7 @@ export class Stack extends Construct implements ITaggable {
*
* Instead, the process takes two deployments:
*
* ### Deployment 1: break the relationship
* **Deployment 1: break the relationship**:
*
* - Make sure `consumerStack` no longer references `bucket.bucketName` (maybe the consumer
* stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just
Expand All @@ -1193,7 +1191,7 @@ export class Stack extends Construct implements ITaggable {
* between the two stacks is being broken.
* - Deploy (this will effectively only change the `consumerStack`, but it's safe to deploy both).
*
* ### Deployment 2: remove the bucket resource
* **Deployment 2: remove the bucket resource**:
*
* - You are now free to remove the `bucket` resource from `producerStack`.
* - Don't forget to remove the `exportValue()` call as well.
Expand Down