hasura / hasura/graphql-engine

Minor mismatch in file names in docs for step: Create Hasura Metadata

Open
#10,393 0 comments 0 reactions 0 assignees View on GitHub
c/docs ddnbugbounty-2024 k/v3-bug
Dominant language
TypeScript
Stars
32.1k
Forks
3k
PR merge metrics
PR metrics pending

Description

### Component
Docs

### What is the current behaviour?
For [this step](https://hasura.io/docs/3.0/getting-started/build/connect-to-data/create-source-metadata#step-1-create-the-hasura-metadata), the file referenced is `.env.my_subgraph.local` in the explanation, but the code snippet shows the file as `my_subgraph/.env.my_subgraph` (`.local` is missing the code snippet file name).

### What is the expected behaviour?
The file name should be the same

### How to reproduce the issue?

1. Navigate to the [step: Create Hasura Metadata](https://hasura.io/docs/3.0/getting-started/build/connect-to-data/create-source-metadata#step-1-create-the-hasura-metadata)
2. Read the snippet telling the user to update the environments

### Screenshots or Screencast
Screenshot 2024-07-15 at 4 58 41 PM

### Please provide any traces or logs that could help here.
None

### Any possible solutions/workarounds you're aware of?
None

### Keywords

Contributor guide

Open the contributing guide

Research direction

Open the linked “Create Hasura Metadata” documentation step and compare the explanation's `.env.my_subgraph.local` with the code snippet's `my_subgraph/.env.my_subgraph`. Update the mismatched filename in the snippet, then reread the step to confirm both references match.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.