fairlearn icon indicating copy to clipboard operation
fairlearn copied to clipboard

DOC: landing page does not update

Open romanlutz opened this issue 2 years ago • 2 comments

Describe the issue linked to the documentation

When making changes to the landing page in a PR the changes do not show up on the website after merging the PR.

Suggest a potential alternative/fix

The following script is executed after the website build to push all the files to the website repository fairlearn/fairlearn.github.io: https://github.com/fairlearn/fairlearn/blob/main/.circleci/push_doc.sh

That script does account for the JS of the landing page but not the index.html. [I am not sure if the CSS is copied, that should also be checked.]

Options to fix include:

  • always copying the newly generated landing page
  • checking if there were changes and copying in that case

romanlutz avatar Jan 13 '23 11:01 romanlutz

if [ "$CIRCLE_BRANCH" = "main" ]
then
    echo "Copying landing_page.js into js directory"
    ls $GENERATED_DOC_DIR/..
    cp $GENERATED_DOC_DIR/../landing_page.js js/


    # Please by any chance,  Does the solution happen to be something repetitive like

     ls $GENERATED_DOC_DIR/..
     cp $GENERATED_DOC_DIR/../landing_page_style.css css/

     ls $GENERATED_DOC_DIR/..
     cp $GENERATED_DOC_DIR/../index.html   .
fi

eskayML avatar Aug 10 '23 01:08 eskayML

Looks fine to me. Are we forgetting the fonts and images folders, though?

romanlutz avatar Aug 11 '23 15:08 romanlutz