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

Scraping changes needed before November 16th - AWS Documentation changes coming #256

Closed
kmcquade opened this issue Oct 17, 2020 · 6 comments · Fixed by #307
Closed

Scraping changes needed before November 16th - AWS Documentation changes coming #256

kmcquade opened this issue Oct 17, 2020 · 6 comments · Fixed by #307
Assignees
Labels
aws-docs Updates or fixes to AWS docs

Comments

@kmcquade
Copy link
Collaborator

I just got this from the IAM Documentation team (first time I learned there is such a team!)


We chatted a while back about your Policy Sentry code in GitHub that scrapes the IAM Actions, resources, and condition keys documentation. We will delete those pages in 30 days and redirect traffic to the matching page in the new Service Authorization Reference.

Action item: Within the next 30 days, we recommend that you review the policy_sentry code and update it to scrape the new pages. The content format of these new pages and the HTML file names have not changed. If your code supports server redirects, then it should not be affected at all. However, we still recommend that you use the new URL.

Today:

On November 16:

  • The AWS Docs server will begin permanently redirecting customers from the old page to the matching page in the new guide.
  • The IAM User Guide TOC will still include the high-level Actions, resources, and condition keys page. Choosing that TOC entry redirects you to the new guide.
  • On or before that date, we will remove the existing Actions, resources, and condition keys pages from GitHub.

If you have any questions or recommendations for documentation improvements, please let us know.

Thanks,
IAM Documentation


FYI - @aidansteele, @0xdabbad00

@kmcquade kmcquade added the aws-docs Updates or fixes to AWS docs label Oct 17, 2020
@kmcquade
Copy link
Collaborator Author

Update: To my surprise, the scraping process still worked by just changing the URL.

BASE_DOCUMENTATION_URL = "https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_actions-resources-contextkeys.html"

Let's assume that will work for now, but might break at some point on or before November 16th. In the meantime, I'll leave this issue open.

kmcquade added a commit that referenced this issue Oct 17, 2020
…ndition Keys. Future-proofed some unit tests to prevent them from breaking after AWS updates their docs. (#258)

Related to #256
@kmcquade kmcquade self-assigned this Oct 17, 2020
@reetasingh
Copy link
Contributor

@kmcquade are we on track for this?

@0xdabbad00
Copy link

The change just went through last night. Parliament's scraping is broken. I'll look into it on my end. awsdocs/iam-user-guide@0eb32aa
image

saikirankv pushed a commit to saikirankv/policy_sentry that referenced this issue Nov 18, 2020
…ndition Keys. Future-proofed some unit tests to prevent them from breaking after AWS updates their docs. (salesforce#258)

Related to salesforce#256
@0xdabbad00
Copy link

All I had to do for Parliament was specify different URLs: duo-labs/parliament@d371b6b

My scraping works now.

@kmcquade
Copy link
Collaborator Author

kmcquade commented Dec 1, 2020

I believe this was fixed by @saikirankv in #258

I'll wait to close this until the automation that updates the documentation runs. Once that PR happens and we can verify it was successful, I will close.

@kmcquade
Copy link
Collaborator Author

Fixed by #307

kmcquade added a commit that referenced this issue Dec 18, 2020
…ore-nov-16-2020

Made data scraping changes; fixes to unit tests. Fixes #256
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aws-docs Updates or fixes to AWS docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants