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

Update documentation for usage and deployment #1906

Open
rjzupkoii opened this issue Feb 14, 2024 · 0 comments
Open

Update documentation for usage and deployment #1906

rjzupkoii opened this issue Feb 14, 2024 · 0 comments
Labels
documentation Changes to documentation only (e.g., README, Guide, Wiki Pages, etc.)
Milestone

Comments

@rjzupkoii
Copy link
Collaborator

Since there have been changes to the underlying libraries, update the documentation to reflect these changes and make sure new users can easily use the template.

@rjzupkoii rjzupkoii added the documentation Changes to documentation only (e.g., README, Guide, Wiki Pages, etc.) label Feb 14, 2024
@rjzupkoii rjzupkoii added this to the 2024 Refresh milestone Feb 14, 2024
@rjzupkoii rjzupkoii self-assigned this Feb 14, 2024
rjzupkoii added a commit that referenced this issue Feb 14, 2024
@rjzupkoii rjzupkoii modified the milestones: 2024 Refresh, Documentation Feb 15, 2024
@rjzupkoii rjzupkoii removed their assignment Mar 15, 2024
WillFuller added a commit to WillFuller/WillFuller.github.io that referenced this issue May 10, 2024
# Merged changes from Upstream Fork

* Increase font size in code blocks

See academicpages#59

* Adds missing semi-colon

* fix font awesome code icon in syntax box

* Fix encoding issue with bib files

* add goodreads to site

* change orcid color

* add medium icon

* add medium profile

* Resolve Google Scholar link not displayed

There was as slight typo in the logic due to which the google scholar link for the respective author's profile set in Config was not being displayed.

* Adding pronouns field to author profile

* Add Google Analytics 4 Support

* fix: Remove deprecated JavaScript to avoid load error from 404 page

* Update files to be ignored

* + webrick to gem file

* academicpages#1902 RM excerpt in pages

* Start updating the README

* academicpages#456 Use real Google Scholar link as an example

* Update issue templates

* RM minimal mistakes changelog

* academicpages#1906

* Edit readme

* + Syntax highlighting example

* Update README.md

* Update README

* Correct syntax

* Streamline config organization for new users

* Add Mastodon to social media

* Closes academicpages#696 with new Kaggle link

* Adjustments to Kaggle link

* Closes academicpages#271 with addition of arXiv

* academicpages#244, academicpages#1600, academicpages#1917 update font awesome to v6, add icons

* Closes academicpages#1911 with update to Academicons

* Closes academicpages#1671 with a new favicon

* academicpages#462 update inline documentation

* academicpages#1041 allow links to wrap

* Closes academicpages#1773 with update to HTML

* Closes academicpages#45 with an update to the CV generator

* academicpages#33, academicpages#1919 Possible missing template fix, bump MathJax to 3.0

* academicpages#1153 add Zhihu

* Closes academicpages#1905 with updates to documentation

* Closes academicpages#693 with updates to documentation and location of citation

* Closes academicpages#820 with updated style

* added missing spanish translations and updated some of the previous ones on ui-text-yml

* Replace `polyfill.io`

* Closes academicpages#1972, update Markdown documentation

* Closes academicpages#1936 with setting to hide RSS feed

* academicpages#1935 clean-up the footer follow a bit

* RM old development override

* Make it clearer where the footnotes are

* academicpages#1975 ignore files created by npm

* Closes academicpages#339 with a fixed masthead

* academicpages#1975 version updates, manage jQuery from npm

* Closes academicpages#1970 with responsive element

* Fix typo

* Closes academicpages#1999

* scroll in sidebar

* scroll in sidebar

* Add scroll to sidebar and adjust media query for screen adaptability

* Closes academicpages#2029 with update to sidebar

* Closes academicpages#1917 with with icon, FA bump to 6.5.2

* Update _config.yml

# Added More Info and blanked out the template filler material.

* added to short left hand bio

* Commented out most of the example publication

* couldn't comment out the link, so changed text from The paper can be downloaded here to test link, and redirected the link to the correct test file

* Comment out 2012-03-01-talk-1.md

* Commented out 2013-03-01-tutorial-1.md

* added some text so that the rest renders blank 2012-03-01-talk-1.md

* Commented out 2014-02-01-talk-2.md

* Comment out 2014-03-01-talk-3.md

* Comment out 2012-08-14-blog-post-1.md

* Update 2012-08-14-blog-post-1.md

* Comment out Update 2199-01-01-future-post.md

* Comment out portfolio-1.md

* Comment out portfolio-2.html

* Commented out pubs and talks for now navigation.yml

* Update cv.md

* Update cv.md

* rename to about about.md

* Update _config.yml

* Rename webpage main title

* Update cv.md

  - figured out how to properly comment out the links to stuff
  - added Scotts email
  - started to begin summary for each job

* Update cv.md

* Update cv.md

* Create 2021-04-20-iop-poster-optimising.md

* Update and rename 2021-04-20-iop-poster-optimising.md to 2021-04-06-iop-poster-optimising.md

* added poster file

* academicpages#2061 Update README with note on dependencies

* Closes academicpages#2055 with adjustment to masthead-height

* Adjust variable name to prevent confusion

* Update casing of template name

* managed to empty out the CV when stuff isn't there

* hidden blogposts for now until I add some more

* added some detail to CV

* added some more intro details for the about page

---------

## Main Repo Credits

Co-authored-by: Steve <sbitner@uwf.edu>
Co-authored-by: Rob Williams <jayrobwilliams@gmail.com>
Co-authored-by: sigma67 <benedikt.putz@wiwi.uni-regensburg.de>
Co-authored-by: naveenarun <notatroll.troll@gmail.com>
Co-authored-by: Mohit_Gupta <52665879+Mohit-15@users.noreply.github.com>
Co-authored-by: Bhavish Pahwa <53102161+bp-high@users.noreply.github.com>
Co-authored-by: amyzlc <6166519+amyzlc@users.noreply.github.com>
Co-authored-by: Sonny Arora <sonnyarora@Sonnys-MacBook-Air.local>
Co-authored-by: Bhav Beri <43399374+bhavberi@users.noreply.github.com>
Co-authored-by: rjzupkoii <rjzii@yahoo.com>
Co-authored-by: johnhandleyd <translatjohn@gmail.com>
Co-authored-by: SukkaW <isukkaw@gmail.com>
Co-authored-by: Maximiliano <maximilianogalindo7@gmail.com>
WillFuller added a commit to WillFuller/WillFuller.github.io that referenced this issue May 10, 2024
# Merged changes from Upstream Fork

* Increase font size in code blocks

See academicpages#59

* Adds missing semi-colon

* fix font awesome code icon in syntax box

* Fix encoding issue with bib files

* add goodreads to site

* change orcid color

* add medium icon

* add medium profile

* Resolve Google Scholar link not displayed

There was as slight typo in the logic due to which the google scholar link for the respective author's profile set in Config was not being displayed.

* Adding pronouns field to author profile

* Add Google Analytics 4 Support

* fix: Remove deprecated JavaScript to avoid load error from 404 page

* Update files to be ignored

* + webrick to gem file

* academicpages#1902 RM excerpt in pages

* Start updating the README

* academicpages#456 Use real Google Scholar link as an example

* Update issue templates

* RM minimal mistakes changelog

* academicpages#1906

* Edit readme

* + Syntax highlighting example

* Update README.md

* Update README

* Correct syntax

* Streamline config organization for new users

* Add Mastodon to social media

* Closes academicpages#696 with new Kaggle link

* Adjustments to Kaggle link

* Closes academicpages#271 with addition of arXiv

* academicpages#244, academicpages#1600, academicpages#1917 update font awesome to v6, add icons

* Closes academicpages#1911 with update to Academicons

* Closes academicpages#1671 with a new favicon

* academicpages#462 update inline documentation

* academicpages#1041 allow links to wrap

* Closes academicpages#1773 with update to HTML

* Closes academicpages#45 with an update to the CV generator

* academicpages#33, academicpages#1919 Possible missing template fix, bump MathJax to 3.0

* academicpages#1153 add Zhihu

* Closes academicpages#1905 with updates to documentation

* Closes academicpages#693 with updates to documentation and location of citation

* Closes academicpages#820 with updated style

* added missing spanish translations and updated some of the previous ones on ui-text-yml

* Replace `polyfill.io`

* Closes academicpages#1972, update Markdown documentation

* Closes academicpages#1936 with setting to hide RSS feed

* academicpages#1935 clean-up the footer follow a bit

* RM old development override

* Make it clearer where the footnotes are

* academicpages#1975 ignore files created by npm

* Closes academicpages#339 with a fixed masthead

* academicpages#1975 version updates, manage jQuery from npm

* Closes academicpages#1970 with responsive element

* Fix typo

* Closes academicpages#1999

* scroll in sidebar

* scroll in sidebar

* Add scroll to sidebar and adjust media query for screen adaptability

* Closes academicpages#2029 with update to sidebar

* Closes academicpages#1917 with with icon, FA bump to 6.5.2

* Update _config.yml

# Added More Info and blanked out the template filler material.

* added to short left hand bio

* Commented out most of the example publication

* couldn't comment out the link, so changed text from The paper can be downloaded here to test link, and redirected the link to the correct test file

* Comment out 2012-03-01-talk-1.md

* Commented out 2013-03-01-tutorial-1.md

* added some text so that the rest renders blank 2012-03-01-talk-1.md

* Commented out 2014-02-01-talk-2.md

* Comment out 2014-03-01-talk-3.md

* Comment out 2012-08-14-blog-post-1.md

* Update 2012-08-14-blog-post-1.md

* Comment out Update 2199-01-01-future-post.md

* Comment out portfolio-1.md

* Comment out portfolio-2.html

* Commented out pubs and talks for now navigation.yml

* Update cv.md

* Update cv.md

* rename to about about.md

* Update _config.yml

* Rename webpage main title

* Update cv.md

  - figured out how to properly comment out the links to stuff
  - added Scotts email
  - started to begin summary for each job

* Update cv.md

* Update cv.md

* Create 2021-04-20-iop-poster-optimising.md

* Update and rename 2021-04-20-iop-poster-optimising.md to 2021-04-06-iop-poster-optimising.md

* added poster file

* academicpages#2061 Update README with note on dependencies

* Closes academicpages#2055 with adjustment to masthead-height

* Adjust variable name to prevent confusion

* Update casing of template name

* managed to empty out the CV when stuff isn't there

* hidden blogposts for now until I add some more

* added some detail to CV

* added some more intro details for the about page

---------

## Main Repo Credits
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes to documentation only (e.g., README, Guide, Wiki Pages, etc.)
Projects
None yet
Development

No branches or pull requests

1 participant