Skip to content

chore: ISS-162615 Add object member documentation #212

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

erazemk
Copy link
Contributor

@erazemk erazemk commented Apr 16, 2025

Copy link
Contributor

🌟 EkLine Reviewer

Hello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page.

For questions or feedback, please email [email protected].

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

EkLine

🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'channel' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


⚠️ [EkLine] reported by reviewdog 🐶

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

| `name` | text | | The name of the channel. If provided, this will be unique across all channels in the Dev org. It's case insensitive and must contain the characters [A-Za-z0-9_-]. |


🚫 [EkLine] reported by reviewdog 🐶

'comment' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

Prefer English terms over Latin abbreviations. Use 'that is' instead of 'i.e.'. (EK00026)

| `external_ref` | text | | The external reference to associate with the entry. This must be unique across the entry's siblings, i.e. all children of its parent. |


🚫 [EkLine] reported by reviewdog 🐶

'component' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'conversation' should use sentence-style capitalization. (EK00037)


⚠️ [EkLine] reported by reviewdog 🐶

Consider using 'customer' instead of 'rev'. (EK25033)

| `participant_uids` | reference (collection) -> [#category:user] | | Globally unique ID of DevRev rev users |


⚠️ [EkLine] reported by reviewdog 🐶

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

| `turing_active` | bool | | Whether Turing is active on the conversation. Will be true when Turing is active and false when it stops responding or when a dev user responds to the conversation. |


🚫 [EkLine] reported by reviewdog 🐶

'custom_link' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'custom_part' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'directory' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'dm' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'enhancement' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


⚠️ [EkLine] reported by reviewdog 🐶

Consider using 'customer' instead of 'Rev'. (EK25033)

| `rev_score` | float | | Rev Score of the enhancement |


⚠️ [EkLine] reported by reviewdog 🐶

Consider using 'customer' instead of 'Rev'. (EK25033)

| `rev_score_tier` | enum | | Rev Score tier of the enhancement |


🚫 [EkLine] reported by reviewdog 🐶

'feature' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'group' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'incident' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'issue' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


⚠️ [EkLine] reported by reviewdog 🐶

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

| `release_version_ids` | reference (collection) -> [#record:version] | | Versions that will contain the resolving commit IDs |


⚠️ [EkLine] reported by reviewdog 🐶

Consider using 'customer' instead of 'Rev'. (EK25033)

| `rev_org_ids` | reference (collection) -> [#record:account #record:revo] | | Rev orgs associated to issues |


🚫 [EkLine] reported by reviewdog 🐶

'link' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'linkable' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'meeting' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'microservice' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'object_member' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'opportunity' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'money' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'product' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'revu' should use sentence-style capitalization. (EK00037)


⚠️ [EkLine] reported by reviewdog 🐶

Consider using 'customer' instead of 'Rev'. (EK25033)

| `description` | rich_text | | Description of the Rev user. |


⚠️ [EkLine] reported by reviewdog 🐶

Suggestions:

  • Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
  • Consider using 'customer' instead of 'Rev'. (EK25033)

| `external_uid` | text | | External ref is a mutable unique identifier for a user within the Rev organization from your primary customer record. If none is available, a good alternative is the email address/phone number which could uniquely identify the user. If none is specified, a system-generated identifier will be assigned to the user. |


⚠️ [EkLine] reported by reviewdog 🐶

Consider using 'customer' instead of 'Rev'. (EK25033)

| `rev_org` | reference -> [#record:account #record:revo] | | The ID of the parent Rev Organization. |


🚫 [EkLine] reported by reviewdog 🐶

'runnable' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'sysu' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'tag' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'task' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'test_custom_type' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'ticket' should use sentence-style capitalization. (EK00037)


🚫 [EkLine] reported by reviewdog 🐶

'Fixed Fields' should use sentence-style capitalization. (EK00037)


⚠️ [EkLine] reported by reviewdog 🐶

Consider using 'customer' instead of 'rev'. (EK25033)

| `rev_oid` | reference -> [#record:account #record:revo] | | Globally unique ID for a DevRev rev org |


⚠️ [EkLine] reported by reviewdog 🐶

Consider using 'customer' instead of 'Rev'. (EK25033)

| `visibility` | enum | | The visibility of the object. If 'internal', the object is visible within the Dev organization. If 'external', it is visible to both the Dev organization and Rev users. If not set, the default visibility is 'external'. |

Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [EkLine] reported by reviewdog 🐶

'Key Capabilities' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [EkLine] reported by reviewdog 🐶

'account' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [EkLine] reported by reviewdog 🐶

'postal_address' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [EkLine] reported by reviewdog 🐶

'airdrop_authorization_policy' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [EkLine] reported by reviewdog 🐶

'airdrop_platform_group' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [EkLine] reported by reviewdog 🐶

'article' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [EkLine] reported by reviewdog 🐶

Consider using 'customer' instead of 'Rev'. (EK25033)

| `shared_with` | permission (collection) | | The list of Rev user, groups and dynamic groups with whom the article is shared and the corresponding roles. |

Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [EkLine] reported by reviewdog 🐶

'resource' should use sentence-style capitalization. (EK00037)

Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [EkLine] reported by reviewdog 🐶

Use 'DevRev' instead of 'devrev'. (EK25050)

| `content_blocks` | reference | | Content blocks used in the article (relevant only for devrev/rt articles). |

Copy link
Contributor

Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [EkLine] reported by reviewdog 🐶

'capability' should use sentence-style capitalization. (EK00037)

@@ -0,0 +1,25 @@
Object members define which users belong to which groups.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Object members object type lists users that belong to a single group."

@@ -1,8 +1,6 @@
# Supported DevRev object types for Airdrop
# DevRev object types that Airdrop can import
Copy link
Contributor

Choose a reason for hiding this comment

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

Page titles come from public.yml. Having an H1 in the page itself creates a redundant heading.

Suggested change
# DevRev object types that Airdrop can import

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants