Support Disabling GitHub Pages

Open Beginner friendly
#109 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Quiet
Tech stack
github, python, yaml
Domain
devops

Research direction

Start at asfyaml/feature/github/pages.py around the TODO at line 93 and inspect how .asf.yaml GitHub Pages settings are represented. Verify that the configuration can explicitly disable GitHub Pages, and confirm the resulting schema or behavior matches the issue's goal of retiring the existing site.

Written by the indexing model from the issue text.

Description

We've recently accepted a repository that previously served documentation on GitHub Pages. We're retiring that site in favour of serving it at arrow.apache.org. While we could disable the site from the GitHub UI, we'd prefer to explicitly disable it from .asf.yaml.

I see this has been marked as TODO: https://github.com/apache/infrastructure-asfyaml/blob/b898fe3bfcedd58c8e8bb1ae47526339bafd1b40/asfyaml/feature/github/pages.py#L93

I don't mind contributing a PR for this.

Dominant language
Python
Stars
16
Forks
23
Avg merge
1d 5h
Merged PRs (30d)
6

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/infrastructure-asfyaml

All issues in apache/infrastructure-asfyaml

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.