microsoft / microsoft/devcenter-catalog

Clearer documentation on use of ADE Extensibilty model

Open
#88 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PowerShell
Stars
52
Forks
194
Avg merge
16h 53m
Merged PRs (30d)
1

Description

I am currently working on testing the extensibility model with use of Terraform, but it is not clear to me how the "Connect the image to your environment definition" works.

I have added this as the content of my enviroment.yaml file which is placed on Github which the ADE connects too, however when I try and sync it does not show up.

name: WebApp
summary: Deploys Web App on Terraform Container
description: Deploys an Azure Web App with Terraform
runner: "test.azurecr.io/customimage:1.0.0"

Is this the only content I need besides the README.md file on the github repo? (would love it if you added an example structure with content on your github example list.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the documentation for “Connect the image to your environment definition” and review the environment.yaml and README.md structure described in the issue. Clarify which files and fields are required for syncing, and add a representative GitHub example; done means a newcomer can follow the example and understand why the environment appears after sync.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, terraform
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.