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.

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

chore(docs): Remove user guide as part of move to new repo #1470

Merged
merged 13 commits into from
Feb 4, 2019
Merged

chore(docs): Remove user guide as part of move to new repo #1470

merged 13 commits into from
Feb 4, 2019

Conversation

Doug-AWS
Copy link
Contributor

@Doug-AWS Doug-AWS commented Jan 2, 2019

Pull Request Checklist

  • Testing
    • Unit test added
    • CLI change?: manually run integration tests and paste output as a PR comment
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
  • Title and Description
    • Change type: title prefixed with fix, feat will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.

@Doug-AWS Doug-AWS requested a review from a team as a code owner January 2, 2019 21:45
@Doug-AWS
Copy link
Contributor Author

Doug-AWS commented Jan 2, 2019

I wasn't sure what to do with the Reference section at the end of the tools, so I just left it and renamed the topic tool-ref.rst.

eladb
eladb reviewed Jan 3, 2019
View reviewed changes
docs/src/index.rst Outdated
`Test-Driving AWS in the Free Usage Tier <http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-free-tier.html>`_.

To obtain an AWS account, go to `aws.amazon.com <https://aws.amazon.com>`_ and click :guilabel:`Create an AWS Account`.
This documentation is the refernce for the |cdk|.
Copy link
Contributor

Choose a reason for hiding this comment

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

typo

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

docs/src/tool-ref.rst Outdated
.. _tool_ref:

####################
|cdk| Tool Reference
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems like a duplicate (also exists on docs.aws)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll delete the file.

docs/src/index.rst Outdated
AWS CloudFormation Library <cloudformation>
Tools <tools>
Writing Constructs <writing-constructs>
Tool Reference <tool-ref>
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's just remove this from here and leave only the reference docs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@eladb
Copy link
Contributor

eladb commented Jan 3, 2019

Let's just delete the content that was migrated. I don't see value in maintaining a copy. We can always find it in the git history.

@RomainMuller
Copy link
Contributor

I agree with @eladb. I feel git's whole point is to keep an achieve of the previous state of everything, and it's pretty good at that. I would just drop the files and move on.

@eladb
Copy link
Contributor

eladb commented Jan 8, 2019

@Doug-AWS let's get this thing merged! I think we are ready

@Doug-AWS
Copy link
Contributor Author

Okay, I blew away docs/archive

@eladb
Copy link
Contributor

eladb commented Jan 13, 2019

Now it seems this PR just deletes all the files under docs/src. I think we should add some reference to the new user guide so people who are used to find the user guide in github.io can find it after this change.

eladb
eladb reviewed Jan 14, 2019
View reviewed changes
docs/src/index.rst
To get started see :doc:`getting-started`

.. image:: screencast.gif

Copy link
Contributor

Choose a reason for hiding this comment

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

Is this commented out?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it's in the guide now: https://docs.aws.amazon.com/CDK/latest/userguide/what-is.html

@Doug-AWS
Update index.rst
fffb934 
Include link to user guide in docs.aws.amazon.com.
eladb
eladb suggested changes Jan 14, 2019
View reviewed changes
docs/src/index.rst Outdated
AWS CloudFormation Library <cloudformation>
Tools <tools>
Writing Constructs <writing-constructs>
Reference <reference>
Copy link
Contributor

Choose a reason for hiding this comment

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

Didn't we intend to keep reference?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, adding it back in.

@Doug-AWS
Update index.rst
904db42 
Oops, deleted trailing underscore.
@Doug-AWS
Update index.rst
e08b4b5 
Added the reference back in.
@Doug-AWS Doug-AWS changed the title chore(docs): Archived user guide as part of move to new repo chore(docs): Remove user guide as part of move to new repo Jan 14, 2019
@Doug-AWS
Copy link
Contributor Author

I've merged master, so we should be good to go.

@Doug-AWS Doug-AWS mentioned this pull request Jan 23, 2019
Closed
@RomainMuller
Copy link
Contributor

The CodeBuild check fails, apparently probably due to a file that was deleted but shouldn't have:

Generating reference docs toctree under .staging/reference.rst...
cat: .staging/reference.rst.template: No such file or directory

@Doug-AWS
Copy link
Contributor Author

Well that was dumb of me. I'll add it back in.

@RomainMuller
Copy link
Contributor

Added a merge commit from master, in hopes this makes the build pass (it was blocked due to an un-related integration test error).

@eladb eladb merged commit 91194d4 into master Feb 4, 2019
@eladb eladb deleted the dougsch/mv-doc-repo branch February 4, 2019 23:19
moofish32 pushed a commit to moofish32/aws-cdk that referenced this pull request Feb 5, 2019
@Doug-AWS @moofish32
chore(docs): move developer guide to docs.aws.amazon.com (aws#1470)
db75215
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eladb eladb eladb approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Doug-AWS @eladb @RomainMuller