Opened 18 months ago
Closed 18 months ago
#15001 closed defect (fixed)
Links to example files in Toolshed Building and Distributing bundles documentation
Reported by: | Owned by: | Zach Pearson | |
---|---|---|---|
Priority: | moderate | Milestone: | |
Component: | Documentation | Version: | |
Keywords: | Cc: | pett, Tom Goddard | |
Blocked By: | Blocking: | ||
Notify when closed: | Platform: | all | |
Project: | ChimeraX |
Description
Roden Luo points out that links to example code files are missing in the ChimeraX Toolshed Building and Distributing Bundles documentation.
"I come to this repo from https://www.cgl.ucsf.edu/chimerax/docs/devel/writing_bundles.html#bundle-sample-code. It is documented that "Because the sample code includes C++ source code." But there is no C++ code (_sample_pyapi.cpp and _sample_pybind11.cpp as mentioned) in this repo. A few other listed files in the doc do not exist, either.
Not a big deal. But somewhat confusing. The same holds for https://github.com/RBVI/ChimeraX-Bundle-Template-TOML."
Change History (6)
comment:1 by , 18 months ago
Component: | Tool Shed → Documentation |
---|
comment:2 by , 18 months ago
comment:3 by , 18 months ago
I could just as well put the contents of the zip file in those GitHub repos.
comment:4 by , 18 months ago
Cc: | added |
---|---|
Reporter: | changed from | to
comment:5 by , 18 months ago
The zip file is created on the fly from whatever the current source is, so if the sample code gets updated or enhanced, no one has to remember to tediously remake the zip archive.
comment:6 by , 18 months ago
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
Re-enabled zip download while retaining references to GitHub sample code.
I believe the inability to fetch the zip file is easily remediable, but some commands have to be run as user 'apache' on the server. I can run the cgi script as myself and get the file, but apache needs to be able to run it (need to run a "git config" command as apache). Once, it's working, we can at least partially revert the changes Zach made (some changes that mention the pyproject.toml option should be retained).
So, have to wait until I can corner Greg or Scooter for a few minutes.