This task is to create a documentation site at docs.memberplatform.org using MkDocs and GitLab Pages.

Example 1

Example 2

Related: #3409318: DrupalCon Atlanta: Update Recipes documentation to use mkdocs and publish to GitLab pages

Remaining tasks:

  1. Review GitLab Pages documentation and examples above to understand what needs to be done
  2. Set up `mkdocs.yml`, `.gitlab-ci.yml`, and `docs` folder
  3. Populate docs with some dummy content
  4. Ask JD to configure the DNS records and GitLab settings to host the docs at docs.memberplatform.org
CommentFileSizeAuthor
#9 member-3512318-mkdocs-screenshot.png81.58 KBalexdmccabe

Issue fork member-3512318

Command icon 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

jdleonard created an issue. See original summary.

jdleonard’s picture

Issue summary: View changes
jdleonard’s picture

jdleonard’s picture

Issue summary: View changes
Issue tags: +Atlanta2025
alexdmccabe’s picture

I'll take this on.

alexdmccabe’s picture

Assigned: Unassigned » alexdmccabe

alexdmccabe’s picture

Status: Active » Needs review

This is ready for review.

alexdmccabe’s picture

jdleonard’s picture

Assigned: alexdmccabe » jdleonard

Looking good! Assigning to me to replace license with GPL 2.0

alexdmccabe’s picture

Sorry. I must have grabbed the wrong license. Good catch.

It lives: https://project.pages.drupalcode.org/member/

Should I mark this as fixed?

jdleonard’s picture

Status: Needs review » Needs work

Just 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!!

jdleonard’s picture

Issue summary: View changes
Status: Needs work » Fixed
Related issues: +#3515896: Enable custom domains for GitLab Pages

Cloudflare 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.

alexdmccabe’s picture

alexdmccabe’s picture

@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.

jdleonard’s picture

Assigned: jdleonard » Unassigned

@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!

alexdmccabe’s picture

That'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.

jdleonard’s picture

Happy to follow core, thanks!

Fixed a stray character that caused the GitLab link in the footer to not work.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.