This task is to create a documentation site at docs.memberplatform.org using MkDocs and GitLab Pages.
Related: #3409318: DrupalCon Atlanta: Update Recipes documentation to use mkdocs and publish to GitLab pages
Remaining tasks:
- Review GitLab Pages documentation and examples above to understand what needs to be done
- Set up `mkdocs.yml`, `.gitlab-ci.yml`, and `docs` folder
- Populate docs with some dummy content
- Ask JD to configure the DNS records and GitLab settings to host the docs at docs.memberplatform.org
| Comment | File | Size | Author |
|---|---|---|---|
| #9 | member-3512318-mkdocs-screenshot.png | 81.58 KB | alexdmccabe |
Issue fork member-3512318
Show commands
Start within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
Comments
Comment #2
jdleonardComment #3
jdleonardComment #4
jdleonardComment #5
alexdmccabeI'll take this on.
Comment #6
alexdmccabeComment #8
alexdmccabeThis is ready for review.
Comment #9
alexdmccabeThis is available to preview here:
https://issue.pages.drupalcode.org/-/member-3512318/-/jobs/4795170/artif...
https://issue.pages.drupalcode.org/-/member-3512318/-/jobs/4795170/artif...
Comment #10
jdleonardLooking good! Assigning to me to replace license with GPL 2.0
Comment #12
alexdmccabeSorry. I must have grabbed the wrong license. Good catch.
It lives: https://project.pages.drupalcode.org/member/
Should I mark this as fixed?
Comment #13
jdleonardJust confirmed with drumm that Drupal's GitLab Pages doesn't currently support custom domains (i.e. for docs.memberplatform.org). He advised me to create a feature request, which I shall.
MemberPlatform.org uses Cloudflare so I'm going to see whether I can simply proxy the subdomain from there.
Leaving this open and assigned to me until I have resolution on that.
Thank you for getting this set up!!
Comment #15
jdleonardCloudflare proxy seemingly isn't an option because of Drupal.org's Fastly-based protections. Added a simple redirect in the interim.
Marking this as fixed and if #3515896: Enable custom domains for GitLab Pages gets fixed, I'll create a follow-up issue to take advantage of the custom domain in GitLab Pages.
Also crediting rocketeerbkw who helped debug the Cloudflare page rule attempts.
Comment #16
alexdmccabeComment #17
alexdmccabe@jdleonard Do you still want this assigned to you since it is marked as fixed?
No problem if so. Just trying to figure out standards for this project.
Comment #18
jdleonard@alexdmccabe My preference is for whatever the best practice is. I'm going to assume from the question that it is to unassign when fixed. Please educate me!
Comment #19
alexdmccabeThat's what core does, but my understanding is that contrib modules can do whatever they want with it, there isn't a prescribed way. So it's up to you, really. Whatever works.
Comment #23
jdleonardHappy to follow core, thanks!
Fixed a stray character that caused the GitLab link in the footer to not work.