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.

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

How to submit a new intent #624

Conversation

pauldyson
Copy link
Contributor

A guide to how to submit a new intent as discussed with @kriswest. This is dependent on PR 587 as it refers to some of the files in that PR

Copy link
Contributor

@mistryvinay mistryvinay left a comment

Choose a reason for hiding this comment

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

I am seeing differences in how we format the name for intents. Spaces or no-spaces, camel-case etc.

For example for ViewProfile we have the following syntax:

id: ViewProfile
sidebar_label: ViewProfile
title: ViewProfile
hide_title: true
---```

Could we update submit-new-intent to the following please:
```---
id: SubmitNewIntent
sidebar_label: SubmitNewIntent
title: How to Submit a New Intent PR
hide_title: true
---```

Copy link
Contributor Author

@pauldyson pauldyson left a comment

Choose a reason for hiding this comment

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

Updated SubmitNewIntent Id

@pauldyson
Copy link
Contributor Author

I am seeing differences in how we format the name for intents. Spaces or no-spaces, camel-case etc.

For example for ViewProfile we have the following syntax:

id: ViewProfile
sidebar_label: ViewProfile
title: ViewProfile
hide_title: true
---```

Could we update submit-new-intent to the following please:
```---
id: SubmitNewIntent
sidebar_label: SubmitNewIntent
title: How to Submit a New Intent PR
hide_title: true
---```

I've change the Id but the sidebar_label and title I've left the same. These are consistent with the sidebar labels and titles of other informational pages such as API Overview and Context Data Specification

@rikoe rikoe added the Context Data & Intents Contexts & Intents Discussion Group label Mar 31, 2022
@mistryvinay
Copy link
Contributor

I am seeing differences in how we format the name for intents. Spaces or no-spaces, camel-case etc.
For example for ViewProfile we have the following syntax:

id: ViewProfile
sidebar_label: ViewProfile
title: ViewProfile
hide_title: true
---```

Could we update submit-new-intent to the following please:
```---
id: SubmitNewIntent
sidebar_label: SubmitNewIntent
title: How to Submit a New Intent PR
hide_title: true
---```

I've change the Id but the sidebar_label and title I've left the same. These are consistent with the sidebar labels and titles of other informational pages such as API Overview and Context Data Specification

looks good to me. @kriswest are you review and merge this pls.

@kriswest
Copy link
Contributor

This is blocked until #587 is merged as its based on it... Great content though, looking forward to merging it in.

Copy link
Contributor

@kriswest kriswest left a comment

Choose a reason for hiding this comment

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

Image paths need to be corrected. Have added some links as suggestions at the same time.

Once merged you should be able to go to: https://github.com/singletracksystems/FDC3/blob/how-to-submit-a-new-intent/docs/guides/submit-new-intent.md
and see the images render.

docs/guides/submit-new-intent.md Outdated Show resolved Hide resolved
docs/guides/submit-new-intent.md Outdated Show resolved Hide resolved
docs/guides/submit-new-intent.md Outdated Show resolved Hide resolved
docs/guides/submit-new-intent.md Outdated Show resolved Hide resolved
docs/guides/submit-new-intent.md Outdated Show resolved Hide resolved
docs/guides/submit-new-intent.md Outdated Show resolved Hide resolved
pauldyson and others added 6 commits April 22, 2022 15:28
Co-authored-by: Kris West <kris@cosaic.io>
Co-authored-by: Kris West <kris@cosaic.io>
Co-authored-by: Kris West <kris@cosaic.io>
Co-authored-by: Kris West <kris@cosaic.io>
Co-authored-by: Kris West <kris@cosaic.io>
Co-authored-by: Kris West <kris@cosaic.io>
@kriswest kriswest changed the base branch from master to context-data-and-intents-consolidated-update-branch May 20, 2022 14:45
@mistryvinay mistryvinay merged commit 65e778f into finos:context-data-and-intents-consolidated-update-branch May 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Context Data & Intents Contexts & Intents Discussion Group docs Documentation intents project infrastructure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants