Skip to content

Publish documentation for Virtualization SDK 2.0.0 #120

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 152 commits into from
May 8, 2020
Merged

Publish documentation for Virtualization SDK 2.0.0 #120

fdrozdowski merged 152 commits into from
May 8, 2020

Conversation

@fdrozdowski
Copy link
Contributor

@fdrozdowski fdrozdowski commented May 7, 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 documentation for SDK is currently hosted in an S3 bucket. We want to publish it via GitHub pages. The gh-pages branch needs to be updated with static files that correspond to the Virtualization SDK 2.0.0 documentation.

What is the new behavior?

The documentation that will be published can be viewed here: https://fdrozdowski.github.io/virtualization-sdk/.

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
ankursarin and others added 24 commits October 30, 2019 22:26
@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/
@jeffngo
PYT-868 Lua to Python - Change plugin config to expect optional lua n… (
676012f 
#98)

* PYT-868 Lua to Python - Change plugin config to expect optional lua name field
@ravi-cm
PYT-1257 Document requirements for successful inactive plugin upgrade
7b477ac 
Reviewed at: http://reviews.delphix.com/r/57705/
@jeffngo
Revert "PYT-868 Lua to Python - Change plugin config to expect option…
6194a4c 
…al lua n… (#98)" (#102)

This reverts commit 676012f.
@muralinimmagadda
Fixes #96 dvp init hitting TypeError on Windows10 (#99)
e140b5a
@fdrozdowski
Fixes #91 Move docs into SDK repo (#91)
ed306cf
@fdrozdowski
Remove hooksconfig
76b0690
@fdrozdowski
Modify SDK version format to be compatible with PEP440 (#106)
1c147e2
@fdrozdowski
Merge pull request #105 from fdrozdowski/release-docs-2.0.0
ad958e5 
Move docs into SDK repo
@ankursarin
SDK 2.0.0 Docs review (fixes #100) (delphix#109)
5636d1f 
SDK 2.0.0 Docs review (fixes #100)
@fdrozdowski
Point the SDK to dvp-api 1.1.0 (delphix#108)
eaf409e 
https://pypi.org/project/dvp-api/1.1.0/
@fdrozdowski
Fix bumpversion config and bump SDK version to 2.0.0 (delphix#112)
37a4f6d
@ankursarin
Add SDK 2.0.0 Release Notes (closes delphix#113) (delphix#114)
4ee103b 
Add SDK 2.0.0 Release Notes delphix#113
closes delphix#113
@fdrozdowski
Merge branch 'release/2.0.0' into merge_2.0.0_master
fe0e56f
@fdrozdowski
Docs 2.0.0
7f02d11
@fdrozdowski
Publish docs for Virtualization SDK 2.0.0
87bb211
ankursarin
ankursarin approved these changes May 7, 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 89c9da0 into delphix:gh-pages May 8, 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

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.