serverless / serverless/examples

Clarify the readme?

Open
#459 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
11.5k
Forks
4.4k
Avg merge
2h 55m
Merged PRs (30d)
3

Description

I tried to install the dotnet example using:

install -u https://github.com/serverless/examples/tree/master/aws-dotnet-rest-api-with-dynamodb -n dotnet_example

but it responds with:

Serverless Error ---------------------------------------

serverless.yml not found in .../dotnet_example

So I think the "-n my-project" in the README is perhaps not what is actually needed here?

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

Review the README for the aws-dotnet-rest-api-with-dynamodb example and reproduce the reported install command. Verify which -n usage or project path is correct, update the README accordingly, and confirm that the documented command no longer produces the reported missing serverless.yml error.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.