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

Make examples directly linkable from docs #326

Closed
wants to merge 185 commits into from
Closed

Make examples directly linkable from docs #326

wants to merge 185 commits into from

Conversation

levb
Copy link
Contributor

@levb levb commented Apr 25, 2022

  • Added rich READMEs to hello-world and serverless examples. They should be linked to directly from the docs, without the need to duplicate the contents nor the code.
  • Eliminated the term "hello" from most unrelated use-cases, removed it from all examples other than hello-world.

See also mattermost/mattermost-developer-documentation#1061

@levb levb added 2: Dev Review Requires review by a core committer Work In Progress Not yet ready for review 2: Editor Review Requires review by an editor labels Apr 25, 2022
@levb levb requested a review from azigler July 7, 2022 12:44
@levb levb mentioned this pull request Jul 7, 2022
14 tasks
@levb levb requested a review from DHaussermann July 7, 2022 12:46
@levb levb removed 2: Dev Review Requires review by a core committer Work In Progress Not yet ready for review labels Jul 7, 2022
Copy link
Contributor

@azigler azigler left a comment

Choose a reason for hiding this comment

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

Nice restructure @levb. Left some comments for you, feel free to ping me on this if more comes up.

I'll keep this PR in mind when I do any future restructuring on the JS examples, as part of my upcoming PR to utilize the MM /dev docker setup.

examples/go/hello-world/README.md Show resolved Hide resolved

The app runs on port `4000`.

## Install the app to Mattermost
Copy link
Contributor

@azigler azigler Jul 8, 2022

Choose a reason for hiding this comment

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

@cwarnermm To your comment above: not necessarily. If we direct them towards using the Docker we'll have configured in /dev with their own docker container (see my other comment above). In that case, the connections will come from docker-container-name (e.g., my-app) instead of localhost and Mattermost won't have an issue with that.

make dist-aws
```

This will create a `./dist/bundle-aws.zip` file containg the AWS-deployable app bundle. Follow the steps in [Admin's Guide](https://developers.mattermost.com/integrate/apps/deploy/deploy-aws) to setup your `appsctl` environment and initialize the AWS resources with `appsctl aws init` command. Then execute
Copy link
Contributor

Choose a reason for hiding this comment

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

The linked guide is ~7 months old, have there been any reports of issues with it or planned changes? Just wanted to get a scope on that as part of this. If no one has tested the instructions in a while, it would be nice to run through that guide then this new one to make sure it all works together.

Copy link
Contributor

Choose a reason for hiding this comment

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

Just closing the loop, I finished the above task over on this Jira ticket.

mickmister and others added 5 commits August 2, 2022 12:43
* fixed the test app

* Updated to server v7.2

* go mod tidy

* try release 7.1

* try 1

* try 2

* try 3

* try 4

* try 5

* try 6
Base automatically changed from lev-example-expand-notify to master August 29, 2022 21:29
@hanzei
Copy link
Contributor

hanzei commented Sep 18, 2022

Does this PR need a rebase?

@hanzei hanzei added the Work In Progress Not yet ready for review label Sep 25, 2022
@levb levb closed this Oct 10, 2022
@mattermod mattermod removed the Work In Progress Not yet ready for review label Oct 10, 2022
@mickmister
Copy link
Member

@levb What are the implications of closing this? Is the intention to support this eventually?

@hanzei hanzei added Invalid This doesn't seem right Docs/Not Needed Does not require documentation and removed 1: PM Review Requires review by a product manager 2: Editor Review Requires review by an editor labels Jan 31, 2023
@levb levb deleted the lev-hello-docs branch February 19, 2023 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs/Not Needed Does not require documentation Invalid This doesn't seem right
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants