-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Remove large downloadable binary files from the repo #6828
Conversation
Files also include |
The links To avoid link checking issues on those links, the
|
As long as those files exist on our domain, I want to validate links to them. |
They can only be validated as external links, since they will not be present in the |
Technically, you're correct. However, since we control where they are stored on our subdomain, we are accountable for ensuring that the links work. Ignoring them effectively means we will never validate links because the external link testing pipeline won't validate them either. |
I agree. I'm not saying that we shouldn't do this, I'm saying that it is impossible to test those links on each build, because they will not be internal anymore.
I don't see a reason why it won't. |
Oh, I see what you're saying. I assumed that as long as the files exist at the location, then the link will resolve. I haven't tested that yet though. The external link checker |
It does, this is its main purpose.
|
Sorry, what I meant to write was that it only tests links outside the devdocs.magento.com subdomain. So the external link check runs on any |
Yes.
This can be set in a separate link checking config. But with such setup we won't be able to test links to files that exist in S3 bucket only and are not part of the build, such as downloads in this case. |
Looks like some images were not even linked. For example, I've got an empty search result for |
By the way, the link checker can help to identify the downloadables that have actual references from topics. |
I'd still like to test that to be sure. I'm sure you're right, but I'm curious... |
Confirmed with @meker12 that we can move the cloud launch readiness PDF along with the rest of the binaries. |
You were right. It fails even when the files exist in production. I'll add the exclude. |
running tests |
running tests |
It should be |
Hi @jeff-matthews, thank you for your contribution! |
Purpose of this pull request
This pull request (PR) moves large downloadable binary files to a new location on S3 (production) so that we don't need to store them in our git repo.
These files take up about 220 MB of storage and don't belong in our repo. Files include:
Affected devdocs pages
Most of the impact is in the Pattern Library guide on devdocs.
Additional info
We will leave the cloud launch checklist PDF in the repo while Magento Support works on moving it to a new location.