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

docs: add jekyll landing page #1699

Merged
merged 17 commits into from
May 10, 2024
Merged

docs: add jekyll landing page #1699

merged 17 commits into from
May 10, 2024

Conversation

casperdcl
Copy link
Member

@casperdcl casperdcl commented Feb 9, 2024

Describe your changes

Using jekyll (picked https://phlow.github.io/feeling-responsive which seems to be more maintained than https://mmistakes.github.io/minimal-mistakes)

Describe any testing you have performed

Link relevant issues

Checklist when you are ready to request a review

  • I have performed a self-review of my code
  • I have added docstrings in line with the guidance in the developer guide
  • I have implemented unit tests that cover any new or modified functionality
  • CHANGELOG.md has been updated with any functionality change
  • Request review from all relevant developers
  • Change pull request label to 'Waiting for review'

Contribution Notes

Please read and adhere to the developer guide and local patterns and conventions.

  • The content of this Pull Request (the Contribution) is intentionally submitted for inclusion in CIL (the Work) under the terms and conditions of the Apache-2.0 License.
  • I confirm that the contribution does not violate any intellectual property rights of third parties

@gfardell
Copy link
Member

gfardell commented May 1, 2024

What is the best way for us to review this? Are there build instructions so we can view it, or could you set up a (short) meeting to show us it if you have it running locally?

@casperdcl
Copy link
Member Author

casperdcl commented May 3, 2024

Instructions for testing are included in the docs in this PR.

I ran this:

  1. download & extract DocumentationHTML from the CI
  2. python -m http.server (for now accessible at http://stfc.cdcl.ml)

@MargaretDuff
Copy link
Member

If it is a quick fix, can this paragraph
image
have slightly bigger text, by default, and be the first thing on the page?

Copy link
Member

@MargaretDuff MargaretDuff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Let's get it in so we have a landing page we can then adapt later on

@casperdcl casperdcl merged commit f1ee0bf into master May 10, 2024
8 checks passed
@casperdcl casperdcl deleted the jekyll-landing branch May 10, 2024 15:06
@casperdcl
Copy link
Member Author

If it is a quick fix, can this paragraph have slightly bigger text, by default, and be the first thing on the page?

not a quick fix unfortunately, but added to #1579 :)

@gfardell gfardell added this to the v24.1.0 milestone Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants