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

Apcs documentation expansion #253

Merged
merged 1 commit into from
Jun 16, 2021
Merged

Conversation

HelenCEBM
Copy link
Contributor

No description provided.

@HelenCEBM HelenCEBM requested a review from wjchulme June 8, 2021 09:37
docs/dataset-apc.md Outdated Show resolved Hide resolved
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Jun 8, 2021

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2945cfc
Status: ✅  Deploy successful!
Preview URL: https://92a835e6.opensafely-docs.pages.dev

View logs

@StevenMaude
Copy link
Contributor

I looked at the Cloudflare Pages failure here because I wondered why that failed, but the GitHub Actions check (should be the same) passed.

When the site was being built, it couldn't find the images/create-repository-owner.png for getting_started.md which is unrelated to the changes here. Probably due to the GitHub/Fastly outages earlier.

@HelenCEBM
Copy link
Contributor Author

@StevenMaude thanks - it's still failing, do you think that's a problem?

@StevenMaude
Copy link
Contributor

StevenMaude commented Jun 15, 2021

So this is my mistake at making a quick assumption :. I got confused because of the Fastly outage last week and assumed there was some weirdness there 😳

Short answer: the fix is to rebase this branch on the main branch, so that it's up-to-date.

Slightly longer answer: the reason for the failure on GitHub Actions, but passing on Cloudflare Pages is a little convoluted. I'll try and explain, because it took me a few minutes to figure out:

  1. @HelenCEBM started working on this branch back at the start of the March.
  2. This was before we checked with mkdocs build --strict which fails on any warnings. A couple of issues also got fixed as a result of using --strict including a broken image link in the Markdown that causes the failure here. These fixes are now in the master branch.
  3. Cloudflare Pages checks out the most recent commit of this branch. The most recent commit of this branch still contains the broken link. If you checkout this pull request branch, it still fails mkdocs build --strict.
  4. The default GitHub Actions checkout action behaviour is that it creates a merge commit of the pull request branch and the branch being merged. (I realised this on looking at the Actions run logs and not being able to find the commit being tested in the repository.) For the merge commit, the docs don't have this broken link because it is fixed in the main branch.

Incidentally, not sure whether we can configure Cloudflare Pages to build a merge of a pull request, and if that is the right thing to do.

@HelenCEBM HelenCEBM force-pushed the APCS-documentation-expansion branch from 8bec974 to 3d80246 Compare June 15, 2021 12:04
@ghickman ghickman force-pushed the APCS-documentation-expansion branch from 3d80246 to 2945cfc Compare June 16, 2021 09:15
@ghickman ghickman merged commit 6ddbe33 into master Jun 16, 2021
@ghickman ghickman deleted the APCS-documentation-expansion branch June 16, 2021 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants