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

Improve JCasC docs #1416

Merged
merged 3 commits into from
Aug 27, 2024
Merged

Improve JCasC docs #1416

merged 3 commits into from
Aug 27, 2024

Conversation

pmarinova
Copy link
Contributor

Add note on how relative file paths are handled.

As mentioned in jenkinsci/configuration-as-code-plugin#695 and jenkinsci/configuration-as-code-plugin#1145, it is not immediately obvious how relative paths are resolved. Adding a simple note may save a considerable time for someone new to this, like me.

Testing done

Submitter checklist

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or Jira
  • Link to relevant pull requests, esp. upstream and downstream changes
  • Ensure you have provided tests - that demonstrates feature works or fixes the issue

Add note on how relative file paths are handled.
@pmarinova pmarinova requested a review from a team as a code owner June 10, 2024 12:50
docs/JCasC.md Outdated Show resolved Hide resolved
docs/JCasC.md Outdated Show resolved Hide resolved
Copy link
Member

@basil basil left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

@basil basil merged commit c0fa64c into jenkinsci:master Aug 27, 2024
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants