processsourcefiles.sh

#######################################################################################
# THIS FILE IS USED BY BOTH THE 'build.sh' and the 'localbuild.sh' DOCS BUILD SCRIPTS #
#######################################################################################

echo '------ PROCESSING SOURCE FILES ------'
# Default to a local build. Otherwise, retreives content from the specified source repos.
# All builds copy or clone the content into the "content" folder of knative/website before starting the Hugo build.
# A temp directory is used and move files around and prevent git clone errors (fails if directory exists).

# Clean slate: Make sure that nothing from a past build exists in the /content/ or /temp/ folders
rm -rf content/en
rm -rf temp

if [ "$BUILDALLRELEASES" = "true" ]
then
# PRODUCTION BUILD (ALL RELEASES)
# Full build for knative.dev (config/production). Contributors can also use this for personal builds.
  echo '------ BUILDING ALL DOCS BRANCHES/RELEASES ------'
  # Build Knative docs from:
  # - https://github.com/"$FORK"
  # - https://github.com/"$REPO"/community

  # Build all branches (assumes $FORK contains all docs branches)
  echo '------ Cloning Community and Pre-release docs (main) ------'
  # "main" branch
  echo 'Getting blog posts and community owned samples from the main branch of' "$FORK"
  git clone --quiet -b main https://github.com/"$FORK".git content/en
  echo 'Getting pre-release development docs from main branch'
  # Move "pre-release" docs content into the 'development' folder:
  mv content/en/docs content/en/development
  # DOCS BRANCHES
  echo '------ Cloning all docs releases ------'
  # Get versions of released docs from their branches in "$FORK"
  # Versions are defined in website/scripts/docs-version-settings.sh
  # If this is a PR build, then build that content as the latest release (assume PR preview builds are always from "latest")
  echo 'Getting the archived docs releases from branches in:' "$FORK"
  r=$OLDESTVERSION
  while [[ $r -le $LATESTVERSION ]]
  do
    CLONE="temp/release-0.${r}"
    echo 'Getting docs from: release-0.'"${r}"
    git clone --quiet -b "release-0.${r}" "https://github.com/${FORK}.git" "$CLONE"
    if [ "$r" = "$LATESTVERSION" ]
    then
      echo 'The /docs/ section is built from the' '/release-0.'"${r}" 'branch of' "$FORK"
      mv "$CLONE"/docs content/en/docs
    else
      # Only use the "docs" folder from all branches/releases
      mv "$CLONE"/docs content/en/v0."$r"-docs
    fi
    (( r = r + 1 ))
  done
  LOCALBUILD="false"

elif [ "$BUILDSINGLEBRANCH" = "true" ]
then
# SINGLE REMOTE BRANCH BUILD
# Build only the content from $FORK and $BRANCH
  echo '------ BUILDING SINGLE REMOTE BRANCH ------'
  echo 'The /docs/ section is built from the' "$BRANCH" 'branch of' "$FORK"
  git clone --quiet -b "$BRANCH" https://github.com/"$FORK".git content/en
  LOCALBUILD="false"
else
# DEFAULT: LOCAL BUILD
# Assumes that knative/docs, /community, and /website are cloned to the same directory.
  LOCALBUILD="true"
  echo '------ BUILDING YOUR LOCAL KNATIVE/DOCS CLONE ------'
  echo 'Copying local clone of knative/docs into the /docs folder under:'
  pwd
  cp -r ../docs content/en/
  if [ -d "../community" ]; then
    echo 'Also copying the local clone of knative/community into the /community/contributing folder.'
    cp -r ../community/* content/en/community/contributing
  else
    echo 'A local clone of knative/community is not found, skipping that content.'
  fi
fi

# Build knative/community
if [ "$LOCALBUILD" = "false" ]
then
  echo ' - ----- Cloning contributor docs ------'
  echo 'Getting Knative community and contributor guidelines'
  if ! [ "$BUILDENVIRONMENT" = "production" ]
  then
    # Try to build /community from remote or PR
    # Check if $FORK includes the /community (remote and PR builds)
    if ! (git ls-remote --quiet git@github.com:"$REPO"/community.git)
    then
      echo 'No /community fork found in' "$REPO"
      DEFAULTCOMMUNITY="true"
    else
      # Build /community from $REPO fork
      echo 'Building from the main branch of' "$REPO"'/community'
      git clone --quiet -b main https://github.com/"$REPO"/community.git temp/community
      DEFAULTCOMMUNITY="false"
    fi
  else
    DEFAULTCOMMUNITY="true"
  fi

  # Build knative/community for production builds and by default
  if [ "$DEFAULTCOMMUNITY" = "true" ]
  then
    echo 'Building from the main branch of' "$DEFAULTORG"'/community'
    # Default to knative/community
    git clone --quiet -b main https://github.com/"$DEFAULTORG"/community.git temp/community
  fi
  # Move files into existing "contributing" folder
  mv temp/community/* content/en/community/contributing
fi

# CLEANUP
# Delete temporary directory
# (clear out unused files, including archived-copies/past-versions of blog posts and contributor samples)
echo 'Cleaning up temp directory used during this site build.'
rm -rf temp

###################################################
# Process fully-qualified hard coded URLs that link
# between the knative/docs and knative/community repos
source scripts/convert-repo-ulrs.sh

#########################################################
# Process content in .md files (MAKE RELATIVE LINKS WORK)
# We want users to be able view and use the source files in GitHub as well as on the site.
# Therefore, the following changes need to be made to all docs files prior to Hugo site build.
# Convert GitHub enabled source, into HUGO supported content:
#  - For all Markdown files under the /content/ directory:
#    - Skip all:
#      - Markdown link with fully qualified HTTP(s) URL is 'external'
#      - GitHub file (.git* files)
#      - non-docs directories
#    - Ignore Hugo site related files (avoid "readfile" shortcodes):
#      - API shell files (serving-api.md, eventing-contrib-api.md, eventing-api.md)
#    - For all remaining Markdown files:
#      - Remove all '.md' file extensions from within Markdown links "[]()"
#      - For SEO convert README to index:
#       - Replace all in-page URLS from "README.md" to "index.html"
#       - Rename all files from "README.md" to "index.md"
#      - Adjust relative links by adding additional depth:
#       - Exclude all README.md files
#       - Convert './' to '../'
#       - Convert '../' to '../../'
echo 'Converting all links in GitHub source files to Hugo supported relative links...'
# Convert relative links to support Hugo
find . -type f -path '*/content/*.md' ! -name '*_index.md' ! -name '*index.md' ! -name '*README.md' \
    ! -name '*serving-api.md' ! -name '*eventing-contrib-api.md' ! -name '*eventing-api.md' \
    ! -name '*build-api.md' ! -name '*.git*' ! -path '*/.github/*' ! -path '*/hack/*' \
    ! -path '*/node_modules/*' ! -path '*/test/*' ! -path '*/themes/*' ! -path '*/vendor/*' \
    -exec sed -i '/](/ { s#(\.\.\/#(../../#g; s#(\.\/#(../#g; }' {} +
# Convert all relative links from README.md to index.html
find . -type f -path '*/content/*.md' ! -name '_index.md' \
    -exec sed -i '/](/ { /http/ !{s#README\.md#index.html#g} }' {} +
# Convert all Markdown links to HTML
find . -type f -path '*/content/*.md' \
    -exec sed -i '/](/ { /http/ !{s#\.md##g} }' {} +

###############################################
# Process file names (HIDE README.md FROM URLS)
# For SEO, dont use "README" in the URL
# (convert them to index.md OR use a "readfile" shortcode to nest them within a _index.md section file)
#
# Rename "README.md" files to "index.md" to avoid unnecessary lower-level _index.md files
# (and to prevent deeply nested shortcodes ==> double markdown processing issues).
# The "readfile" shortcodes are still used but only for files the exclude shortcodes.
#
echo 'Converting all standalone README.md files to index.md...'
# Some README.md files should not be converted to index.md, either because that README.md
# is a file that's used only in the GitHub repo, or to prevent Hugo build conflicts
# (index.md and _index.md files in the same directory is not supported).
#
# Do not convert the following README.md files to index.md:
#  - files in doc releases v0.6 and earlier
#  - README.md files in folders that also include _index.md files
find . -type f -path '*/content/*/*/*' -name 'README.md' \
     ! -path '*/.github/*' ! -path '*/hack/*' ! -path '*/node_modules/*' \
     ! -path '*/test/*' ! -path '*/themes/*' ! -path '*/vendor/*' \
    -execdir bash -c 'if ! [ -e _index.md -o -e index.md ]; then echo "BARE README AT ${PWD#*/}, WILL NOT BE RENDERED."; fi' -- {} \;

# GET HANDCRAFTED SITE LANDING PAGE
echo 'Copying the override files into the /content/ folder'
cp -rfv content-override/* content/