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

Migrate organization websites #170

Closed
11 tasks done
redeboer opened this issue Jul 27, 2022 · 2 comments
Closed
11 tasks done

Migrate organization websites #170

redeboer opened this issue Jul 27, 2022 · 2 comments
Assignees
Labels
📝 Docs Improvements or additions to documentation
Milestone

Comments

@redeboer
Copy link
Member

redeboer commented Jul 27, 2022

The pages for this repository are currently hosted on RTD. Its URL is a bit ugly though (compwa-org.rtfd.io), especially since the original ComPWA C++ project has been archived and ComPWA is to be considered an organization anyway.

Since the pages for compwa-org on RTD are not versioned, we could host them on GitHub Pages, particularly on the namespace for the ComPWA GitHub organization (compwa.github.io). That URL currently hosts pycompwa's documentation, but that could be moved to compwa.github.io/pycompwa. The only thing that's lost is the ability to have PR previews, but that could be kept by just letting compwa-org.rtfd.io redirect to compwa.github.io (see RTD redirects).

ComPWA ++ / pycompwa

Preview Give feedback

Organization page redirects

Preview Give feedback
  1. 📝 Docs
    redeboer
@redeboer redeboer added ❔ Question Discuss this matter in the team 📝 Docs Improvements or additions to documentation labels Jul 27, 2022
@redeboer redeboer moved this to 🆕 Icebox in Student projects Jul 27, 2022
@redeboer redeboer changed the title Migrate organization website to compwa.github.io Migrate organization websites Jan 13, 2024
@redeboer redeboer self-assigned this Jan 13, 2024
@redeboer redeboer removed the ❔ Question Discuss this matter in the team label Jan 13, 2024
@redeboer
Copy link
Member Author

redeboer commented Jan 17, 2024

Here's a bash script for checking which ComPWA GitHub pages exist using the gh CLI:

COMPWA_REPOS=$(gh repo list ComPWA --visibility=public --json name --jq '.[].name' | sort -f)
COMPWA_PAGES=()
for repo in $COMPWA_REPOS; do
  URL="https://compwa.github.io"
  if [[ $repo != "compwa.github.io" ]]; then
    URL="$URL/$repo"
  fi
  response=$(curl -s --head -w "%{http_code}" $URL -o /dev/null)
  if [[ $response -eq 200 ]] || [[ $response -eq 301 ]]; then
    COMPWA_PAGES+="$URL "
  fi
done
for page in $(echo "${COMPWA_PAGES[@]}" | tr ' ' '\n' | sort); do
  echo $page
done

As of writing, these are:

URL
compwa.github.io
compwa.github.io/ampform-dpd
compwa.github.io/benchmarks
compwa.github.io/gluex-amplitude
compwa.github.io/legacy ComPWA++ Sphinx API
compwa.github.io/legacy-doxygen ComPWA++ Doxygen API
compwa.github.io/polarimetry
compwa.github.io/policy
compwa.github.io/pycompwa pycompwa
compwa.github.io/strong2020-salamanca
compwa.github.io/tensorwaves

@redeboer
Copy link
Member Author

Forced redirects from RTD work again since v10.15.1 🎉
https://docs.readthedocs.io/en/stable/changelog.html#version-10-15-1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Docs Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant