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.

Sign up for GitHub

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

Jump to bottom

Updates the Javascript code in listing.html in a new file #300

Merged
merged 17 commits into from
Jul 3, 2024
Merged

Updates the Javascript code in listing.html in a new file #300

merged 17 commits into from
Jul 3, 2024

Conversation

Murdock9803
Copy link
Member

Fixes

Description

The Javascript code related to listing of cards based on the choices of user, resides in the <head> section of listing.html. This pull request shifts the code to a new file called listing.js in the docs/_assets/js folder. Also, the pull request updates the code to follow concepts of modern (ES6) javascript.

Technical details

The pull request performs the following tasks:

  • Updates the functions and code to follow ES6 javascript concepts.
  • For example, replaces var with let or const, so that variables are not globally scoped wherever needed.
  • Replaces the document.write() method with Document Object Manipulation. The document.write() is old and not preferable.
  • Utilizes the javascript DOM for all the tasks related to filtering of resources in listing.js.
  • Adds proper documentation for all the functions and sections of code for better understandability.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin 
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Murdock9803 added 11 commits July 2, 2024 23:16
@Murdock9803
created a new file listing.js in _assets/js/
8dc76f2
@Murdock9803
shifted the javascript code from listing.html to listing.js
3ca883f
@Murdock9803
added documentation about the file in listing.js
815ec6e
@Murdock9803
updated the getUrlVars function with modern javascript
1003d4d
@Murdock9803
updated code to assign variable from getUrlVars fucntion in concise form
ea48a25
@Murdock9803
replaced the document.write method with javascript dom manipulation
8dbd15a
@Murdock9803
updated the document.write method by creating dynamic style with Java…
17ef0c1 
…script DOM
@Murdock9803
added documentation about the resourcenav-{known/unknown} Javascript …
7f0d9fe 
…section
@Murdock9803
updated code for displaying of options in the resourcenavbar, removin…
6e2a106 
…g document.write method
@Murdock9803
added end of file line to listing.js
a9dee09
@Murdock9803
formatted the code with prettier code formatter
7489046
@Murdock9803 Murdock9803 requested a review from a team as a code owner July 2, 2024 18:28
@Murdock9803 Murdock9803 requested review from Shafiya-Heena and possumbilities and removed request for a team and Shafiya-Heena July 2, 2024 18:28
@Murdock9803
Copy link
Member Author

@possumbilities please review the PR for any changes needed to be done 🙌
I tested the functionality with updated code, and everything works fine.

possumbilities
possumbilities approved these changes Jul 3, 2024
View reviewed changes
Copy link
Contributor

@possumbilities possumbilities left a comment

Choose a reason for hiding this comment

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

Everything is looking solid to me, Approved!

@possumbilities possumbilities merged commit bfd039c into main Jul 3, 2024
@possumbilities possumbilities deleted the upgrade-listing-js branch July 3, 2024 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@possumbilities possumbilities possumbilities approved these changes

Assignees

@possumbilities possumbilities

@Murdock9803 Murdock9803

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve the JavaScript syntax in the listing.html page
2 participants
@Murdock9803 @possumbilities