Create new content for Apps Structure topic by neflyte · Pull Request #1111 · mattermost/mattermost-developer-documentation

neflyte · 2022-09-08T14:05:36Z

Summary

New and improved content for the Apps Structure topic

Topics

This PR adds Hugo support for the following:

Compass Icons
- shortcode: {{<compass-icon "icon-name" "icon description">}}
Improved collapsable text blocks based on the existing Bootstrap styles and Compass icons
- shortcode: {{<collapse id="xxxx" title="yyyy">}}...{{</collapse>}}
External links using the {{<newtabref>}} shortcode will display an icon to indicate the link will open in a new tab
Note sections can optionally append a Compass Icon to the end of the title
- shortcode: {{<note "Note Title" "icon-name" "icon desctipion">}}...{{</note>}}

…s in links of table cells; Fix trailing space when newtabref shortcode is rendered

mattermod · 2022-09-08T14:05:44Z

Hello @neflyte,

Thanks for your pull request! A Core Committer will review your pull request soon. For code contributions, you can learn more about the review process here.

github-actions · 2022-09-08T14:06:36Z

Newest code from mattermod has been published to preview environment for Git SHA 0a95690

github-actions · 2022-09-08T14:07:04Z

Newest code from neflyte has been published to preview environment for Git SHA 0a95690

github-actions · 2022-09-08T14:12:10Z

Newest code from neflyte has been published to preview environment for Git SHA 0a95690

…es for h4, h5, and h6 headings; Modify CSS to not break words used in links in a table cell

github-actions · 2022-09-08T15:46:55Z

Newest code from neflyte has been published to preview environment for Git SHA bd8a61f

…ctory to font directory since compass-icons.css expects its files there; Update Apps structure main topic, manifest, and calls topics; Moved call metadata (expand) to its own topic

…dlers binding to locations

…ample

…h build; Update Makefile dist target to not pull compass icons; Update Structure topic homepage diagram with simplified version; Update Call metadata topic

…SS styles to not word-break monospaced text in a table cell

…enote extra information instead of a different symbol for each case

…nents and Compass icons; Update collapsable blocks in bindings topic

github-actions · 2022-10-05T17:24:14Z

Newest code from cwarnermm has been published to preview environment for Git SHA c0fbb81

github-actions · 2022-10-05T17:24:33Z

Newest code from neflyte has been published to preview environment for Git SHA 7379871

github-actions · 2022-10-05T17:26:57Z

Newest code from cwarnermm has been published to preview environment for Git SHA 535a8c9

azigler

Looks good!

mickmister

Awesome work @neflyte 👍

Holding back on approving to make sure the css changes are okay. Otherwise LGTM!

mickmister · 2022-10-05T22:59:43Z

site/static/css/styles.css

+h4 {
+    font-size: 1.25rem;
+}
+
+h5 {
+    font-size: 1rem;
+}
+
+h6 {
+    font-size: 0.75rem;
+}


I'm concerned this will affect other parts of the site. @cwarnermm Do you know who owns this site, and may be able to gauge the risk of additions like this?

This is fixing a defect. The h4, h5, and h6 styles were all the same and made headings look incorrect.

@emdecr - Are you open to reviewing this PR's CSS changes to ensure that they won't impact other areas of the site?

mickmister · 2022-10-05T23:06:46Z

site/content/integrate/apps/functionality/_index.md

+
+- [OAuth2 Store]({{< ref "mattermost-api#apps-api" >}}) - store, expand, and retrieve user and App OAuth2 configuration data.
+
+- [Calling other Apps]({{< ref "mattermost-api#apps-api" >}}) - use the Call API to invoke other Apps (experimental).


Not sure if we should advertise this if it's experimental cc @levb

@levb @mickmister How would anyone know if a feature of the Apps framework is "experimental" other than what's in the code or existing docs? Can we refrain from including any experimental stuff in framework releases so this isn't an issue? There's no issue with having experimental stuff in a branch.

This potentially could change with the OAuth 2.0 scopes work coming. @mickmister - We're going to move forward and merge this PR. This content can be updated iteratively as needed if you continue to be concerned.

github-actions · 2022-10-06T16:18:14Z

Newest code from neflyte has been published to preview environment for Git SHA 2bbde8a

site/content/integrate/apps/functionality/_index.md

site/content/integrate/apps/structure/bindings/_index.md

site/content/integrate/apps/structure/_index.md

site/content/integrate/apps/structure/manifest/_index.md

site/content/integrate/apps/structure/call/_index.md

levb · 2022-10-10T17:29:55Z

site/content/integrate/apps/structure/call-metadata/_index.md

@@ -0,0 +1,60 @@
+---
+title: Call metadata


0/5 Expand(ed) call metadata? I'd really like to work the term expand into the section title here since that's what it's all about.

I find it confusing to use the word "expand"; is the emphasis on the expansion or the resulting metadata?
I'd love to have a chat about how best to write this. 🙂

levb · 2022-10-10T17:31:09Z

site/content/integrate/apps/structure/call-metadata/_index.md

+| `summary` | Include key metadata for the field.       |
+| `id`      | Include only relevant identifiers (IDs).  |
+
+### Available information


The "all" mode is also somewhat limited, we may want to document it, specifically for User. 0/5 on the format, but the table feels a little over the top, hard to keep track of.

Unfortunately, this is how the code is written. Readers wouldn't know any of this without looking at the code, and I believe we're trying to avoid that hurdle.

We can definitely update this section when the code is updated. 🙂
Another approach might be to extract this info from the source code directly, in a similar manner to the server API reference.

Co-authored-by: Lev <1187448+levb@users.noreply.github.com>

neflyte · 2022-10-11T16:15:54Z

Ready for your feedback, @levb 🙂

levb

With comments/replies inline

levb · 2022-10-11T16:50:48Z

@neflyte 👍 👍 👍

Co-authored-by: Lev <1187448+levb@users.noreply.github.com>

neflyte added 2 commits September 1, 2022 15:51

Update Apps Structure Manifest topic; Update styles to not break word…

500675b

…s in links of table cells; Fix trailing space when newtabref shortcode is rendered

Merge branch 'master' into nef-apps-structure-content

0a95690

mattermod added the Contributor label Sep 8, 2022

neflyte self-assigned this Sep 8, 2022

neflyte added Work in Progress Not yet ready for review preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories and removed Contributor labels Sep 8, 2022

Update existing content in Apps Structure topic; Fix missing CSS styl…

bd8a61f

…es for h4, h5, and h6 headings; Modify CSS to not break words used in links in a table cell

neflyte added the Contributor label Sep 8, 2022

neflyte added 6 commits September 9, 2022 12:59

Add support for Compass Icons; Move FontAwesome files from fonts dire…

39d7798

…ctory to font directory since compass-icons.css expects its files there; Update Apps structure main topic, manifest, and calls topics; Moved call metadata (expand) to its own topic

Add image to Apps Structure topic homepage which illustrates call han…

e8d9a37

…dlers binding to locations

More improvements to App Calls topic

8345f5a

Remove unimplemented or unsupported struct fields; Improve context ex…

7396d4e

…ample

Pull compass icons assets once and commit instead of pulling with eac…

4303bd7

…h build; Update Makefile dist target to not pull compass icons; Update Structure topic homepage diagram with simplified version; Update Call metadata topic

Start updating Bindings sub topic

8bdbe49

neflyte mentioned this pull request Sep 19, 2022

Inconsistency in Documentation and Example mattermost/mattermost-plugin-apps#365

Closed

neflyte added 5 commits September 19, 2022 11:27

Merge branch 'master' into nef-apps-structure-content

20235b1

Further updates to Bindings, call, and call metadata topics; Update C…

1f94ade

…SS styles to not word-break monospaced text in a table cell

Finish up changes to Bindings topic; Use star icon as the symbol to d…

979e9eb

…enote extra information instead of a different symbol for each case

Improve support for collapsable blocks using existing Bootstrap compo…

c666a25

…nents and Compass icons; Update collapsable blocks in bindings topic

Add content in Static assets topic

6bf29cb

neflyte changed the title ~~Create new Apps Structure content~~ Create new content for Apps Structure topic Sep 20, 2022

neflyte removed Work in Progress Not yet ready for review preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories labels Sep 20, 2022

neflyte requested a review from mickmister September 20, 2022 17:49

Merge master into this branch

535a8c9

cwarnermm added preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories and removed preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories labels Oct 5, 2022

azigler approved these changes Oct 5, 2022

View reviewed changes

mickmister reviewed Oct 5, 2022

View reviewed changes

neflyte requested a review from mickmister October 6, 2022 12:14

mickmister approved these changes Oct 6, 2022

View reviewed changes

javaguirre approved these changes Oct 6, 2022

View reviewed changes

neflyte added 2 commits October 6, 2022 12:14

Merge master into this branch to pick up mattermost#1109

f234136

Merge branch 'master' into nef-apps-structure-content

2bbde8a

neflyte added preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories and removed preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories labels Oct 6, 2022

Merge branch 'master' into nef-apps-structure-content

d98013e

levb suggested changes Oct 10, 2022

View reviewed changes

neflyte and others added 2 commits October 11, 2022 12:11

Update description of Bindings

789243f

Apply suggestions from code review

7d26f2c

Co-authored-by: Lev <1187448+levb@users.noreply.github.com>

neflyte requested a review from levb October 11, 2022 16:15

levb approved these changes Oct 11, 2022

View reviewed changes

levb removed the 1: Dev Review Requires review by a core commiter label Oct 11, 2022

neflyte and others added 3 commits October 11, 2022 14:12

Apply suggestions from code review

3c4cbaa

Co-authored-by: Lev <1187448+levb@users.noreply.github.com>

Apply changes from PR reviews

eae738e

Merge branch 'master' into nef-apps-structure-content

16faa92

cwarnermm approved these changes Oct 12, 2022

View reviewed changes

cwarnermm merged commit bcbdd3e into mattermost:master Oct 12, 2022


		- [OAuth2 Store]({{< ref "mattermost-api#apps-api" >}}) - store, expand, and retrieve user and App OAuth2 configuration data.

		- [Calling other Apps]({{< ref "mattermost-api#apps-api" >}}) - use the Call API to invoke other Apps (experimental).

Comments

Conversation

neflyte commented Sep 8, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Topics

Uh oh!

mattermod commented Sep 8, 2022

Uh oh!

github-actions bot commented Sep 8, 2022

Uh oh!

github-actions bot commented Sep 8, 2022

Uh oh!

github-actions bot commented Sep 8, 2022

Uh oh!

github-actions bot commented Sep 8, 2022

Uh oh!

github-actions bot commented Oct 5, 2022

Uh oh!

github-actions bot commented Oct 5, 2022

Uh oh!

github-actions bot commented Oct 5, 2022

Uh oh!

azigler left a comment

Choose a reason for hiding this comment

Uh oh!

mickmister left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neflyte Oct 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 6, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neflyte Oct 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neflyte commented Oct 11, 2022

Uh oh!

levb left a comment

Choose a reason for hiding this comment

Uh oh!

levb commented Oct 11, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

neflyte commented Sep 8, 2022 •

edited

Loading

neflyte Oct 6, 2022 •

edited

Loading

neflyte Oct 11, 2022 •

edited

Loading