How to edit dock website

From DISI
(Redirected from How to update dock website)
Jump to navigation Jump to search

How to update DOCK

Via gitlab.docking.org

  • 1. request an account on gitlab.docking.org from sysadmin
  • 2. login to gitlab.docking.org
  • 3. request "maintainer" access ("developer" will require pull requests) to the DOCK Website repo from sysadmin
  • 4. browse to change files and commit. All the files (probably) are in html/kuntz/. If you are only editing text files, you have our permission to push directly to main.
  • 5. it should push to the public website automatically. (you may need to refresh cache on your browser to see the change)
  • 6. If any problems or questions contact Kyle Petkovic or sysadmin. We are happy to talk to you about making this as easy as we can.

Via git

It works mostly the same as it did on the old DOCK site

Running DOCK

git clone https://gitlab.docking.org/kylep/dock
cd dock/html/kuntz/
python3 -m http.server 8023

Note: It's all html + bootstrap so no special packages are needed

Adding a New Minor DOCK Version

File Location: dock/html/kuntz/DOCK_6/index.htm is where the DOCK 6 html file is located.

You can edit the HTML to add new release note links. In the DOCK_6 folder you can add a new changelog.txt file and then link to it from DOCK_6 using an <a> with an href in the Release Notes: section of DOCK_6/index.htm.

Adding a New Major DOCK Version

  1. Duplicate the DOCK_6 folder and give it a new name
  2. Edit the files inside the new folder
  3. To add the new version to the navigation bar:
    • Go to dock/html/kuntz/components/components.js
    • Search for an existing DOCK version (e.g., "DOCK 6")
    • Duplicate its list item
    • Update the name and href to point to your new DOCK version page

Committing Changes

When your changes are done:

  1. Use git add to stage your modified files
  2. Commit the changes to the repository
  3. The CI/CD pipeline will automatically run and push the changes to public