Update posts.md

[chardaway]

Added content for creating POSTS using UI interface.

I am very sorry that I may have performed an incorrect operation last time, which resulted in incorrect results. So I made the necessary modifications and submitted the application.

Checklist

• The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
• Links to related issues (if applicable)
• Tests for the changes have been added/updated (if applicable)
• Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
• For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

• New Features

  • Enhanced post creation functionality in DataHub.
  • Users can now create Text and Link posts directly through the UI.
  • Detailed steps provided in the Settings tab for creating posts via UI.
  • Option to create posts using the createPost GraphQL mutation remains available.

• Documentation

  • Updated documentation to include detailed steps and images for creating posts using the UI.
  • Revised the section headers for clarity.

[yoonhyejin]

@chardaway Sorry for the delay here! Made small suggestions on the headings

[yoonhyejin]

datahub-project/static-assets#78

this PR should be merged first to include img assets under datahub repo

[chardaway]

Can I close the request "Update posts.md with some screenshot # 69" now? These files already exist, right?

[jjoyce0510]

Hi folks, checking in. Can we get this resolved?

These are great docs!

[coderabbitai]

Walkthrough

The new changes significantly enhance the post creation functionality in DataHub. Users can now easily create posts directly from the UI, choosing between Text and Link types. Additionally, the traditional GraphQL-based post creation method remains supported. The documentation has been updated to reflect these new features with detailed steps and visual aids for UI use, and concise information for GraphQL usage.

Changes

Files	Change Summary
docs/posts.md	Updated: Expanded the "Summary" section, renamed "## Using Posts" to "## Creating Posts", added detailed sections for creating posts using UI and GraphQL.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI
    participant GraphQL
    participant DataHub

    User->>UI: Navigate to Settings tab
    UI-->>User: Display post creation options
    User->>UI: Select post type (Text/Link), enter details
    UI->>DataHub: Create post request
    DataHub-->>UI: Confirm post creation
    UI-->>User: Display success message

    User->>GraphQL: createPost mutation
    GraphQL->>DataHub: Create post request
    DataHub-->>GraphQL: Confirm post creation
    GraphQL-->>User: Return post details

Loading

Poem

In DataHub's realm, new posts arise,
Through UI clicks or GraphQL ties.
Text or Link, the choice is yours,
Create with ease, no need for chores.
Make your content, let it soar!
A rabbit's joy, for sure and more!

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

Outside diff range and nitpick comments (2)

docs/posts.md (2)

Line range hint 38-123: Add necessary blank lines for markdown formatting.

There are several markdown lint issues related to the absence of blank lines around headings and code blocks. These should be fixed to improve readability and adhere to markdown best practices.

+ 
To create a post via API, you can call the [createPost](../graphql/mutations.md#createPost) GraphQL mutation.
+ 
+ 
### GraphQL
+ 
+ 
* [createPost](../graphql/mutations.md#createPost)
* [listPosts](../graphql/queries.md#listposts)
* [deletePosts](../graphql/queries.md#listposts)
+ 
+ 
+ 
##### Create Post
+ 
```graphql
mutation test {
  createPost(
    input: {
      postType: HOME_PAGE_ANNOUNCEMENT, 
      content: {
        contentType: TEXT, 
        title: "Planned Upgrade 2023-03-23 20:05 - 2023-03-23 23:05", 
        description: "datahub upgrade to v0.10.1"
      }
    }
  )
}

<details>
<summary>Tools</summary>

<details>
<summary>LanguageTool</summary><blockquote>

[grammar] ~20-~20: The plural noun “Posts” cannot be used with the article “a”. Did you mean “a new post” or “new Posts”?
Context: ...age, click 'Home Page Posts'. To create a new Posts, click '+ New Posts'. <p align="center"...

(A_NNS)

</blockquote></details>
<details>
<summary>Markdownlint</summary><blockquote>

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

38-38: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

22-22: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

---

26-26: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

---

29-29: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

---

35-35: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

</blockquote></details>

</details>

---

Line range hint `74-123`: **Adjust heading level for consistency.**

The heading level for "GraphQL" should be adjusted to maintain a consistent structure.

```diff
- ### GraphQL
+ ## GraphQL

Tools

LanguageTool

[grammar] ~20-~20: The plural noun “Posts” cannot be used with the article “a”. Did you mean “a new post” or “new Posts”?
Context: ...age, click 'Home Page Posts'. To create a new Posts, click '+ New Posts'. <p align="center"...

(A_NNS)

Markdownlint

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

38-38: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

22-22: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

---

26-26: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

---

29-29: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

---

35-35: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b4e0505 and bb3a37f.

Files selected for processing (1)

• docs/posts.md (1 hunks)

Additional context used

LanguageTool

docs/posts.md

[grammar] ~20-~20: The plural noun “Posts” cannot be used with the article “a”. Did you mean “a new post” or “new Posts”?
Context: ...age, click 'Home Page Posts'. To create a new Posts, click '+ New Posts'. <p align="center"...

(A_NNS)

---

[uncategorized] ~56-~56: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...pe: LINK*title*link*media`. Currently only the IMAGE type is supported, a...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

Markdownlint

docs/posts.md

74-74: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time

(MD001, heading-increment)

---

43-43: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

---

12-12: null
Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)

---

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

38-38: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

74-74: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

122-122: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

122-122: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

75-75: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

121-121: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

123-123: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

46-46: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

53-53: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

22-22: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

---

26-26: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

---

29-29: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

---

35-35: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

---

63-63: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Additional comments not posted (1)

docs/posts.md (1)

16-16: Approved section header change.
This change makes the section title more action-oriented, which is beneficial for clarity.

Tools

Markdownlint

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

[coderabbitai]

Actionable comments posted: 3

Outside diff range and nitpick comments (5)

docs/posts.md (5)

Line range hint 56-56: Add missing comma.

A comma may be missing after the conjunctive/linking adverb 'Currently'.

* `media`. Currently, only the **IMAGE** type is supported, and the URL of the image must be provided

Tools

Markdownlint

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

38-38: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

Line range hint 74-74: Fix heading level.

Heading levels should only increment by one level at a time.

#### Create Post

Tools

Markdownlint

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

38-38: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

Line range hint 75-75: Surround fenced code blocks with blank lines.

Fenced code blocks should be surrounded by blank lines for better readability.

#### Create Post

```graphql
mutation test {
  createPost(

Tools

Markdownlint

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

38-38: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

Line range hint 121-121: Surround fenced code blocks with blank lines.

Fenced code blocks should be surrounded by blank lines for better readability.

##### Delete Post

```graphql
mutation deletePosting { 

Tools

Markdownlint

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

38-38: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

Line range hint 123-123: Surround fenced code blocks with blank lines.

Fenced code blocks should be surrounded by blank lines for better readability.

```graphql
mutation deletePosting { 
  deletePost (
    urn: "urn:li:post:61dd86fa-9e76-4924-ad45-3a533671835e"
  )
}

Tools

Markdownlint

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

38-38: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bb3a37f and 03a3d36.

Files selected for processing (1)

• docs/posts.md (1 hunks)

Additional context used

LanguageTool

docs/posts.md

[uncategorized] ~56-~56: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...pe: LINK*title*link*media`. Currently only the IMAGE type is supported, a...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

Markdownlint

docs/posts.md

74-74: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time

(MD001, heading-increment)

---

43-43: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

---

12-12: null
Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)

---

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

38-38: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

74-74: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

122-122: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

122-122: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

75-75: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

121-121: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

123-123: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

46-46: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

53-53: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

63-63: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Additional comments not posted (5)

docs/posts.md (5)

16-16: Heading change approved.

The heading "## Using Posts" was renamed to "## Creating Posts" to better reflect the new content.

Tools

Markdownlint

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

22-22: Add alt text to images.

Images should have alt text for accessibility.

 <img alt="Creating a new post" width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/new-post.png" />

Likely invalid or redundant comment.

---

26-26: Add alt text to images.

Images should have alt text for accessibility.

 <img alt="Selecting text post type" width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/post-type-text.png" />

Likely invalid or redundant comment.

---

35-35: Add alt text to images.

Images should have alt text for accessibility.

 <img alt="Viewing posts" width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/view-posts.png" />

Likely invalid or redundant comment.

---

29-29: Add alt text to images.

Images should have alt text for accessibility.

 <img alt="Selecting link post type" width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/post-type-link.png" />

Likely invalid or redundant comment.

[coderabbitai]

Actionable comments posted: 5

Outside diff range and nitpick comments (3)

docs/posts.md (3)

Line range hint 76-76: Fix heading level and add blank lines around headings.

Heading levels should only increment by one level at a time and should be surrounded by blank lines.

### Examples

#### Create Post

Tools

Markdownlint

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

Line range hint 77-77: Add blank lines around fenced code blocks.

Fenced code blocks should be surrounded by blank lines for better readability.

#### Create Post

```graphql
mutation test {
  createPost(
    input: {
      postType: HOME_PAGE_ANNOUNCEMENT, 
      content: {
        contentType: TEXT, 
        title: "Planed Upgrade 2023-03-23 20:05 - 2023-03-23 23:05", 
        description: "datahub upgrade to v0.10.1"
      }
    }
  )
}

<details>
<summary>Tools</summary>

<details>
<summary>Markdownlint</summary><blockquote>

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

</blockquote></details>

</details>

---

Line range hint `123-125`: **Add blank lines around fenced code blocks.**

Fenced code blocks should be surrounded by blank lines for better readability.

```diff
##### Delete Post

```graphql
mutation deletePosting { 
  deletePost (
    urn: "urn:li:post:61dd86fa-9e76-4924-ad45-3a533671835e"
  )
}

<details>
<summary>Tools</summary>

<details>
<summary>Markdownlint</summary><blockquote>

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

</blockquote></details>

</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>Review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**

<details>
<summary>Commits</summary>

Files that changed from the base of the PR and between 03a3d36c98290ffafa1e18ec028481732cdf2f4f and 5c93a192e386bfd6d2140e0bf6d4339932ba24ca.

</details>


<details>
<summary>Files selected for processing (1)</summary>

* docs/posts.md (1 hunks)

</details>










<details>
<summary>Additional context used</summary>

<details>
<summary>LanguageTool</summary><blockquote>

<details>
<summary>docs/posts.md</summary><blockquote>

[uncategorized] ~58-~58: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...pe: LINK` * `title` * `link` * `media`. Currently only the **IMAGE** type is supported, a...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

</blockquote></details>

</blockquote></details>
<details>
<summary>Markdownlint</summary><blockquote>

<details>
<summary>docs/posts.md</summary><blockquote>

76-76: Expected: h4; Actual: h5
Heading levels should only increment by one level at a time

(MD001, heading-increment)

---

45-45: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

---

12-12: null
Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)

---

16-16: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

17-17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

76-76: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

124-124: Expected: 1; Actual: 0; Above
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

124-124: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

77-77: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

123-123: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

125-125: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

---

48-48: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

55-55: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

---

65-65: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

</blockquote></details>

</blockquote></details>

</details>
<details>
<summary>Additional comments not posted (6)</summary><blockquote>

<details>
<summary>docs/posts.md (6)</summary><blockquote>

`20-20`: **Fix grammatical error.**

The term "Posts" should be singular.

```diff
- To create a new Post, click '+ New Posts'.
+ To create a new Post, click '+ New Post'.

Likely invalid or redundant comment.

---

25-26: Add alt text to images and fix grammatical errors.

Images in this section are missing alt text, which is important for accessibility.

- <img width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/post-type-text.png" />
+ <img alt="Selecting text post type" width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/post-type-text.png" />

Likely invalid or redundant comment.

---

18-18: Fix grammatical error.

The phrase "Settings tab in the top-right menu" should be "Settings tab in the top-right menu of DataHub."

- To create a post, first navigate to the Settings tab in the top-right menu.
+ To create a post, first navigate to the Settings tab in the top-right menu of DataHub.

Likely invalid or redundant comment.

---

28-29: Add alt text to images and fix grammatical errors.

Images in this section are missing alt text, which is important for accessibility.

- <img width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/post-type-link.png" />
+ <img alt="Selecting link post type" width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/post-type-link.png" />

Likely invalid or redundant comment.

---

34-35: Add alt text to images and fix grammatical errors.

Images in this section are missing alt text, which is important for accessibility.

- <img width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/view-posts.png" />
+ <img alt="Viewing posts" width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/view-posts.png" />

Likely invalid or redundant comment.

---

38-38: Add blank lines around headings.

Headings should be surrounded by blank lines for better readability.

### Create Posts Using the GraphQL

To create a post via API, you can call the [createPost](../graphql/mutations.md#createPost) GraphQL mutation.

Likely invalid or redundant comment.

[coderabbitai]

Add alt text to images and fix grammatical errors.

Images in this section are missing alt text, which is important for accessibility. Also, there's a grammatical error in line 20 where "a new Posts" should be "a new Post".

- <img width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/new-post.png" />
+ <img alt="Creating a new post" width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/new-post.png" />

Committable suggestion was skipped due to low confidence.

[yoonhyejin]

LGTM!

[coderabbitai]

Actionable comments posted: 1

Outside diff range and nitpick comments (3)

docs/posts.md (3)

16-16: Add blank lines around the heading.

Headings should be surrounded by blank lines for better readability.

## Creating Posts

---

18-18: Add blank lines around the heading.

Headings should be surrounded by blank lines for better readability.

### Create Posts Using the UI

Tools

Markdownlint

18-18: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

---

39-39: Add blank lines around the heading.

Headings should be surrounded by blank lines for better readability.

### Create Posts Using the GraphQL

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5c93a19 and ac7409b.

Files selected for processing (1)

• docs/posts.md (1 hunks)

Additional context used

Markdownlint

docs/posts.md

18-18: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)

Additional comments not posted (2)

docs/posts.md (2)

19-19: Fix grammatical error.

The term "Posts" should be singular.

- To create a new Post, click '+ New Posts'.
+ To create a new Post, click '+ New Post'.

Likely invalid or redundant comment.

---

25-25: Fix grammatical error.

The term "Post Type" should be in quotes.

- Click on 'Post Type' to switch between these types.
+ Click on "Post Type" to switch between these types.

Likely invalid or redundant comment.

[coderabbitai]

Add alt text to images.

Images in this section are missing alt text, which is important for accessibility.

- <img width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/new-post.png" />
+ <img alt="Creating a new post" width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/posts/new-post.png" />

Committable suggestion was skipped due to low confidence.