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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the JSON Schema Documentation page #1030

Merged
merged 9 commits into from Sep 12, 2019

Conversation

sladyn98
Copy link
Contributor

Changing the doc to include the Beta Release of JSON Schema

Your checklist for this pull request

馃毃 Please review the guidelines for contributing to this repository.

  • [x ] Make sure you are requesting to pull a topic/feature/bugfix branch (right side) and not your master branch!
  • [ x] Ensure that the pull request title represents the desired changelog entry
  • [ x] Please describe what you did
  • [ x] Link to relevant issues in GitHub or in Jenkins JIRA
  • [ x] Link to relevant pull requests, esp. upstream and downstream changes
  • [ x] Did you provide a test-case? That demonstrates feature works or fixes the issue.

@sladyn98
Copy link
Contributor Author

@oleg-nenashev @Casz This should do it right?

Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

PR checklist is not really followed, not a consumable chamgelog entry I would also suggest to start creating a new documentation page for schema instead of keeping it on landing. Will help with future changes

@sladyn98
Copy link
Contributor Author

https://github.com/jenkins-infra/jenkins.io/tree/master/content/projects/jcasc
Shoudl I create a new page put in the info for the schema @oleg-nenashev

@oleg-nenashev
Copy link
Member

New page under https://github.com/jenkinsci/configuration-as-code-plugin/tree/master/docs/features would be my recommendation

@sladyn98
Copy link
Contributor Author

@oleg-nenashev @Casz This looks fine ?

Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

Please add title to the page and coordinate the merge with the feature release.
Also, my comment about the pull request title has not been addressed yet

docs/features/jsonSchema.md Outdated Show resolved Hide resolved
docs/features/jsonSchema.md Outdated Show resolved Hide resolved
docs/features/jsonSchema.md Outdated Show resolved Hide resolved
@sladyn98 sladyn98 changed the title Beta Release Announcement JSONSchema Document Page. Aug 30, 2019
Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

  • Link from the root pages is missing
  • There is no reference to the old JSON generation and the differences. IMHO it should be documented somehow with proper disclaimers

docs/features/jsonSchema.md Outdated Show resolved Hide resolved
docs/features/jsonSchema.md Outdated Show resolved Hide resolved
docs/features/jsonSchema.md Show resolved Hide resolved
docs/features/jsonSchema.md Show resolved Hide resolved
Co-Authored-By: Oleg Nenashev <o.v.nenashev@gmail.com>
Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

ready to go once the feature is integrated

Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

Updates are needed after recent changes in #980

docs/features/jsonSchema.md Outdated Show resolved Hide resolved
@oleg-nenashev oleg-nenashev added the documentation A PR that adds to documentation - used by Release Drafter label Sep 12, 2019
@oleg-nenashev oleg-nenashev changed the title JSONSchema Document Page. Add the JSON Schema Documentation page Sep 12, 2019
Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

The page still need to be referenced from README. The rest looks good to me

docs/features/jsonSchema.md Outdated Show resolved Hide resolved
docs/features/jsonSchema.md Outdated Show resolved Hide resolved
docs/features/jsonSchema.md Outdated Show resolved Hide resolved
docs/features/jsonSchema.md Outdated Show resolved Hide resolved
@sladyn98
Copy link
Contributor Author

Please add title to the page and coordinate the merge with the feature release.
Also, my comment about the pull request title has not been addressed yet

@oleg-nenashev Yeah added it :)

@sladyn98 sladyn98 requested a review from timja September 12, 2019 12:33
README.md Outdated Show resolved Hide resolved
@oleg-nenashev oleg-nenashev merged commit 17de1bb into jenkinsci:master Sep 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation A PR that adds to documentation - used by Release Drafter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants