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

Context configuration file misnamed #2267

Open
4 tasks
helendduncan opened this issue Oct 29, 2024 · 0 comments
Open
4 tasks

Context configuration file misnamed #2267

helendduncan opened this issue Oct 29, 2024 · 0 comments
Assignees
Labels
documentation Improvements to documentation good first issue This is a good issue for newcomers to the project to tackle
Milestone

Comments

@helendduncan
Copy link

helendduncan commented Oct 29, 2024

✅ Checklist

  • I have searched open and closed issues for duplicates
  • This is a request for a change to documentation
  • This isn't a feature request or bug report
  • This isn't an open-ended question (open a discussion if it is).

📒 Where is the problem?

Deployment docs "Set up context" page say the context configuration file is called context.yaml, when it is actually contexts.yaml.
It also doesn't give the path of the file, which might make it seem like the file should be in $PWD.

We should correct the file name, or perhaps remove it if we think users don't need this detail.

We could add a block which gives the path for the file on Linux/MacOS/Windows.

📝 Required documentation changes

@helendduncan helendduncan added the documentation Improvements to documentation label Oct 29, 2024
@JimMadge JimMadge added this to the Release 5.1.0 milestone Oct 29, 2024
@JimMadge JimMadge changed the title Context(s) for an already deployed SHM Context configuration file misnamed Oct 29, 2024
@JimMadge JimMadge added the good first issue This is a good issue for newcomers to the project to tackle label Oct 29, 2024
@craddm craddm modified the milestones: Release 5.1.0, Release 5.0.2 Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to documentation good first issue This is a good issue for newcomers to the project to tackle
Projects
None yet
Development

No branches or pull requests

3 participants