Skip to content

Move docs into SDK repo #105

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.

Sign up for GitHub

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

Jump to bottom
Merged
fdrozdowski merged 140 commits into from
Apr 30, 2020
Merged

Move docs into SDK repo #105

fdrozdowski merged 140 commits into from
Apr 30, 2020

Conversation

@fdrozdowski
Copy link
Contributor

@fdrozdowski fdrozdowski commented Apr 29, 2020 •
edited
Loading

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build was run locally and any changes were pushed
  • Lint has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

The SDK docs were maintained separately in a private GitLab repository.

What is the new behavior?

The SDK docs sources will be maintained with the code in the GitHub repository. When moving the docs from the GitLab repository, the history from GitLab has been preserved.

Does this introduce a breaking change?

  • Yes
  • No

Other information

skdelphix and others added 30 commits February 11, 2019 18:47
@skdelphix
Initial push
c012eab
@ankursarin
Add initial References
4e7fdb9
@mothslaw
Add first pages to the First Plugin section
973395e
@mothslaw
Add ingestion page
c4ac2c0
@ankursarin
Add decorators and standardize Schemas and Autogenerated Classes
71e23da
@mothslaw
Add info on provisioning
3412fbc
@ankursarin
Add Decorators and update documentation
4b8d18d
@mothslaw
JSON schemas
12f5f5b
@mothslaw
Add Intro Section
15538fe
@ankursarin
Move schema, references, autogenerated classes sections
29b6f0f
@ankursarin
Standardize json highlighting
03f0dd8
@ankursarin
Finished Schemas and Autogenerated Classes
72f3f4b
@ankursarin
Fixed some inconsistencies in the References
8dd6d41
@mothslaw
Add JSON schema summaries
a5a66c5
@mothslaw
Add info about sensitive data
5bd1274
@mothslaw
Add partial info on versioning
d54f2d4
@mothslaw
Add logging reference page
703d39a
@ankursarin
Remove site/ from the repository since it contains the build
62710cf
@ankursarin
All Plugin Operations done
0c87c9d
@ankursarin
Update decorators to new naming scheme
24e2a3e
@ankursarin
Add all classes
de4c3d9
@ankursarin
Update imports for Plugin Operations
6f15a38
@ankursarin
Standardize arguments for plugin operations
4c3ab5e
@ankursarin
Add sample workflows
9061036
@ankursarin
Fix legend
54dc2d3
Add first draft of Getting Started and CLI reference docs
2206b7d
@mothslaw
Update discovery
677bd81
@ankursarin
Add images for all workflows
cec368b
@ankursarin
Add Delphix Libraries
2105a98
@ankursarin
Make Reference pages consistent
c02c9e0
jeffngo and others added 20 commits July 24, 2019 11:55
@jeffngo
PYT-658 GA: Update the docs with manuals on how to write config files…
ebd5e5a 
… for dvp

Reviewed at: http://reviews.delphix.com/r/51210/
@muralinimmagadda
PYT-602 Document details about UserError that can be raised by plugin…
d483957 
… author

PYT-603 Add documentation for using unicode in run_bash

Reviewed at: http://reviews.delphix.com/r/51163/
@muralinimmagadda
PYT-706 Document new plugin classes RemoteConnection, RemoteEnvironme…
d185632 
…nt, RemoteUser, RemoteHost

Reviewed at: http://reviews.delphix.com/r/51522/
@ankursarin
PYT-728 Release Notes for GA
7e26b1e 
Reviewed at: http://reviews.delphix.com/r/51558/
@ankursarin
PYT-730 Documentation Cleanup for GA
97419a7 
Reviewed at: http://reviews.delphix.com/r/51598/
@delphix-jbf
DOC-313 Add current version number to site title for virt-sdk-docs
d771a60 
Reviewed at: http://reviews.delphix.com/r/51678/
PYT-742 update docs for pyt-357
fd1cba7 
Reviewed at: http://reviews.delphix.com/r/52996/
PYT-884 Update plugin docs to inform plugin writers of required param…
7447a43 
…eter changes in the Mount object
@ankursarin
Update .hooksconfig
f7b743c
@delphix-jbf
Update .hooksconfig
99c15b4
@mothslaw
Remove bad info from readme
3355e8e 
Reviewed at: http://reviews.delphix.com/r/53919/
@mothslaw
PYT-1036 Documentation should include example of required properties
1e6b41c 
Reviewed at: http://reviews.delphix.com/r/54910/
@mothslaw
PYT-981 Document what to do when migrations are not sufficient (text)
75a8338 
PYT-984 Documentation for plugin backporting (text)

Reviewed at: http://reviews.delphix.com/r/55505/
@mothslaw
PYT-981 Document what to do when migrations are not sufficient (text)…
364196e 
… (revert)

PYT-984 Documentation for plugin backporting (text) (revert)
@fdrozdowski
PYT-1248 Merge plugin upgrade docs into master VSDK docs
d90a24b 
Reviewed at: http://reviews.delphix.com/r/57181/
@jeffngo
PYT-1274 Comment out any TODOs in the Virtualization SDK docs
0ed9f5d 
Reviewed at: http://reviews.delphix.com/r/57651/
@jeffngo
PYT-1275 Add upgrade workflow to virtualization SDK docs
c5e11d9 
Reviewed at: http://reviews.delphix.com/r/57744/
@ravi-cm
PYT-1257 Document requirements for successful inactive plugin upgrade
7b477ac 
Reviewed at: http://reviews.delphix.com/r/57705/
@fdrozdowski
Fixes #91 Move docs into SDK repo (#91)
ed306cf
@fdrozdowski
Remove hooksconfig
76b0690
@fdrozdowski fdrozdowski linked an issue Apr 29, 2020 that may be closed by this pull request
Move docs into SDK repo #91
Closed
@fdrozdowski fdrozdowski added this to the VSDK Sprint 4/9 - 4/30 milestone Apr 29, 2020
@fdrozdowski fdrozdowski self-assigned this Apr 29, 2020
@fdrozdowski fdrozdowski marked this pull request as ready for review April 29, 2020 21:59
ankursarin
ankursarin approved these changes Apr 29, 2020
View reviewed changes
Copy link
Contributor

@ankursarin ankursarin left a comment

Choose a reason for hiding this comment

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

Ship it!

@fdrozdowski fdrozdowski merged commit ad958e5 into delphix:release/2.0.0 Apr 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mothslaw mothslaw Awaiting requested review from mothslaw

2 more reviewers

@ankursarin ankursarin ankursarin approved these changes

@nhlien93 nhlien93 nhlien93 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@fdrozdowski fdrozdowski

Labels

None yet

Milestone

VSDK Sprint 4/9 - 4/30

Development

Successfully merging this pull request may close these issues.

Move docs into SDK repo