Skip to content

Add admonitions feature to blog/docs#3371

Merged
julieg18 merged 13 commits into
masterfrom
add-admonitions
Mar 23, 2022
Merged

Add admonitions feature to blog/docs#3371
julieg18 merged 13 commits into
masterfrom
add-admonitions

Conversation

@julieg18
Copy link
Copy Markdown
Contributor

@julieg18 julieg18 commented Mar 18, 2022 •
edited
Loading

code:

<admon type="warn">

text text text

</admon>

output:

image

Fixes #3153

@julieg18
Add admonition component to blog
46d1e49 
* add component and insert test into latest blog post
@julieg18 julieg18 marked this pull request as draft March 18, 2022 19:48
@shcheklein shcheklein temporarily deployed to dvc-org-add-admonitions-uamsn0 March 18, 2022 19:48 Inactive
julieg18
julieg18 commented Mar 18, 2022
View reviewed changes
Comment thread src/components/Blog/Post/Markdown/index.tsx Outdated
Comment thread content/blog/2022-03-17-march-22-heartbeat.md Outdated
Comment thread src/components/Blog/Post/Markdown/styles.module.css Outdated
Comment thread src/components/Blog/Post/Markdown/index.tsx Outdated
@julieg18 julieg18 requested review from a team and jendefig March 18, 2022 19:56
yathomasi
yathomasi reviewed Mar 21, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@yathomasi yathomasi left a comment

Choose a reason for hiding this comment

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

Looking good. Tested for nesting as well.
Screen Shot 2022-03-21 at 17 16 36
Also, for details block
Screen Shot 2022-03-21 at 17 32 28
If we come up with similar design to current details block then looking into the implementation I think we can merge/support details block(collapsible) into the admonition as well.

Comment thread src/components/Blog/Post/Markdown/index.tsx Outdated
Comment thread src/components/Blog/Post/Markdown/styles.module.css Outdated
Comment thread src/components/Blog/Post/Markdown/index.tsx Outdated
Comment thread src/components/Blog/Post/Markdown/styles.module.css Outdated
@julieg18
Update admonition design
be93421 
* add rounded corners and took off border
@julieg18 julieg18 temporarily deployed to dvc-org-add-admonitions-uamsn0 March 21, 2022 12:15 Inactive
@julieg18 julieg18 temporarily deployed to dvc-org-add-admonitions-uamsn0 March 21, 2022 12:21 Inactive
@julieg18 julieg18 temporarily deployed to dvc-org-add-admonitions-uamsn0 March 21, 2022 16:01 Inactive
@julieg18 julieg18 temporarily deployed to dvc-org-add-admonitions-uamsn0 March 22, 2022 15:24 Inactive
julieg18 added 2 commits March 22, 2022 10:42
@julieg18
Add Admonition feature to docs as well as blog
a2853fb 
* move admonition to gatsby-theme-iterative-docs
@julieg18
Add docs test
000d2f5
@julieg18 julieg18 temporarily deployed to dvc-org-add-admonitions-uamsn0 March 22, 2022 15:43 Inactive
@julieg18 julieg18 temporarily deployed to dvc-org-add-admonitions-uamsn0 March 23, 2022 11:50 Inactive
@julieg18 julieg18 temporarily deployed to dvc-org-add-admonitions-uamsn0 March 23, 2022 11:52 Inactive
@julieg18 julieg18 temporarily deployed to dvc-org-add-admonitions-uamsn0 March 23, 2022 12:00 Inactive
@julieg18
Copy link
Copy Markdown
Contributor Author

julieg18 commented Mar 23, 2022 •
edited
Loading

Ok, looks like all discussions have been resolved (let me know if I missed something!) and the component has been added to both blog and docs.

Final design:
image

Type options:

  • info (default emoji is ℹ️)
  • tip (default emoji is 💡)
  • warn (default emoji is ⚠️)

Icon options:
tip - 💡
info - ℹ️
warn - ⚠️
fire - 🔥
exclamation - ❗
beetle - 🐞

Are we good to merge? If so, I'll take off the test code and make this pr "ready for review"

@julieg18 julieg18 self-assigned this Mar 23, 2022
@julieg18 julieg18 temporarily deployed to dvc-org-add-admonitions-uamsn0 March 23, 2022 14:39 Inactive
@julieg18 julieg18 temporarily deployed to dvc-org-add-admonitions-uamsn0 March 23, 2022 14:54 Inactive
@julieg18
Copy link
Copy Markdown
Contributor Author

julieg18 commented Mar 23, 2022

Going to go ahead and take off tests!

@julieg18 julieg18 temporarily deployed to dvc-org-add-admonitions-uamsn0 March 23, 2022 14:59 Inactive
@julieg18 julieg18 marked this pull request as ready for review March 23, 2022 14:59
@julieg18 julieg18 requested a review from a team March 23, 2022 15:03
rogermparent
rogermparent approved these changes Mar 23, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@rogermparent rogermparent left a comment

Choose a reason for hiding this comment

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

Great stuff!

@julieg18 julieg18 merged commit 83159e0 into master Mar 23, 2022
@julieg18 julieg18 deleted the add-admonitions branch March 23, 2022 15:46
This was referenced Mar 23, 2022
Merged
Merged
@RCdeWit RCdeWit mentioned this pull request Apr 8, 2022
Closed
iesahin pushed a commit that referenced this pull request Apr 11, 2022
@julieg18 @iesahin
Add admonitions feature to blog and docs (#3371)
8b9ddf6
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@skshetry skshetry skshetry left review comments

@jendefig jendefig Awaiting requested review from jendefig

+4 more reviewers

@iesahin iesahin iesahin left review comments

@casperdcl casperdcl casperdcl left review comments

@yathomasi yathomasi yathomasi left review comments

@rogermparent rogermparent rogermparent approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@julieg18 julieg18

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

admonition support: warnings/hints/notes, etc.

8 participants

@julieg18 @iesahin @rogermparent @casperdcl @skshetry @yathomasi @jendefig @shcheklein