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

Replace toolkit.globus.org refs w/ refs to our own doc fork #12

Open
matyasselmeci opened this issue Jan 18, 2018 · 9 comments
Open

Replace toolkit.globus.org refs w/ refs to our own doc fork #12

matyasselmeci opened this issue Jan 18, 2018 · 9 comments

Comments

@matyasselmeci
Copy link
Contributor

References to the original Globus documentation should be replaced to point to our documentation. From Mattias Ellert:

There are lots of
references to the toolkit.globus.org website and the Globus Alliance
that need to be changed in the specfiles. For example, each package has
a README file providing links to the globus documentation. I know the
sources for the documentation were forked, but do we have a new
location?

== This is the README in the globus-common package ==
$ cat /usr/share/doc/globus-common/README
This package is part of the C Common Libraries component
of the Globus Toolkit. For more information visit:

http://toolkit.globus.org/toolkit/docs/latest-stable/ccommonlib/

Developer's Guide:
http://toolkit.globus.org/toolkit/docs/latest-stable/ccommonlib/developer/

Release Notes:
http://toolkit.globus.org/toolkit/docs/latest-stable/ccommonlib/rn/

Public Interface Guide:
http://toolkit.globus.org/toolkit/docs/latest-stable/ccommonlib/pi/

Quality Profile:
http://toolkit.globus.org/toolkit/docs/latest-stable/ccommonlib/qp/

Migrating Guide:
http://toolkit.globus.org/toolkit/docs/latest-stable/ccommonlib/mig/
== End of file ==
@ellert
Copy link
Member

ellert commented Jan 19, 2018

The sources for the documentation was forked to the gridcf github area:
https://github.com/gridcf/gct-documentation
The part of the documentation that is referenced in the README files is
https://github.com/gridcf/gct-documentation/tree/master/toolkit/docs
with a link latest-stable → 6.0
Where will this be published?

@ellert
Copy link
Member

ellert commented Mar 29, 2018

The README files are updated to point to the GCT documentation in PR #31:

This package is part of the C Common Libraries component
of the Grid Community Toolkit. For more information visit:

https://gridcf.org/gct-docs/ccommonlib/

Developer's Guide:
https://gridcf.org/gct-docs/ccommonlib/developer/

Release Notes:
https://gridcf.org/gct-docs/ccommonlib/rn/

Public Interface Guide:
https://gridcf.org/gct-docs/ccommonlib/pi/

Quality Profile:
https://gridcf.org/gct-docs/ccommonlib/qp/

Migrating Guide:
https://gridcf.org/gct-docs/ccommonlib/mig/

@fscheiner
Copy link
Member

This issue looks fixed to me, so I'm closing it.

@msalle
Copy link
Member

msalle commented Nov 8, 2018

Not sure if any of these are still relevant, but there are still some references to old documentation at globus.org.

Other files we might need to update are the Debian packaging files (if they are still used, otherwise we probably should get rid of them), in particular the control files.

@msalle msalle reopened this Nov 8, 2018
@fscheiner fscheiner mentioned this issue Jul 3, 2019
Merged
@fscheiner
Copy link
Member

@msalle

Not sure if any of these are still relevant, but there are still some references to old documentation at globus.org.

The whole list was already fixed or will get fixed with #92.

@fscheiner
Copy link
Member

@msalle @ellert @matyasselmeci
grepping through the current master branch with #92 applied there are still some old document references existing, though a lot of them can stay as is I think. Not sure about the tests, I assume the listed URLs are not contacted but just used to test URL processing. And as they're working as is, let's not touch them.

What's your opinion on the tests?

I'll work through the unambiguous cases and provide a PR.

~/git-projects/professional/gridcf/gct$ grep -nri '\.globus.org/' *
common/source/test/globus_url_test.c:172:        { "http://www.globus.org/%7Ebester", GLOBUS_SUCCESS,
common/source/test/globus_url_test.c:332:        { "ldap://mds.globus.org/o=Globus,c=US?dn?SUBTREE?hn=pitcairn.mcs.anl.gov-fork", GLOBUS_SUCCESS,
common/source/test/globus_url_test.c:351:        { "ldap://mds.globus.org/ou=MCS,%20o=Argonne%20National%20Laboratory,%20o=Globus,%20c=US?dn?SUBTREE?hn=pitcairn.mcs.anl.gov-fork", GLOBUS_SUCCESS,
common/source/test/globus_url_test.c:391:        { "ldap://mds.globus.org/o=Globus,c=US?%%?SUBTREE?hn=pitcairn.mcs.anl.gov-fork", GLOBUS_URL_ERROR_BAD_ATTRIBUTES },
common/source/test/globus_url_test.c:396:        { "ldap://mds.globus.org/ou=MCS,o=Argonne National Laboratory, o=Globus, c=US?dn?hn=pitcairn.mcs.anl.gov-fork", GLOBUS_URL_ERROR_BAD_DN },
gram/jobmanager/lrms/sge/source/LICENSE.GTPL:3:        http://www.globus.org/toolkit/license.html
gram/jobmanager/source/globus_gram_job_manager_script_tutorial.dox:787:Look at the <a href="http://www.globus.org/about/faq/errors.html">Globus
gram/jobmanager/source/test/jobmanager/failure_test/error_rsl_file_stage_in_shared3.rsl:4:                  (ftp://ftp.globus.org/no/destination/for/stage))
gram/jobmanager/source/test/jobmanager/failure_test/error_rsl_file_stage_in3.rsl:4:                  (ftp://ftp.globus.org/no/destination/for/stage))
gram/jobmanager/source/test/jobmanager/failure_test/error_rsl_file_stage_out3.rsl:4:                  (ftp://ftp.globus.org/no/destination/for/stage))
gridftp/server/src/globus_gridftp_server.h:25: * https://lists.globus.org/mailman/listinfo/gridftp-dev
gridftp/client/source/globus_ftp_client_debug_plugin.example:30:                          "ftp://ftp.globus.org/pub/globus/README",
gridftp/client/source/globus_ftp_client_restart_plugin.example:39:			  "ftp://ftp.globus.org/pub/globus/README",
gsi/gssapi/source/test/gssapi_import_name.c:259:    subject = "cvs.globus.org/192.5.186.90";
gsi/gssapi/source/test/gssapi_import_name.c:423:    name_tok.value = "cvs.globus.org/192.168.1.1";
gsi/gssapi/source/test/release_name_test.c:203:    subject = "cvs.globus.org/192.5.186.90";
gsi/gssapi/source/test/duplicate_name_test.c:323:    subject = "cvs.globus.org/192.5.186.90";
myproxy/source/VERSION:64:    (http://jira.globus.org/browse/GT-387)
myproxy/source/VERSION:133:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7211)
myproxy/source/VERSION:136:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7201)
myproxy/source/VERSION:144:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7209)
myproxy/source/VERSION:149:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7207)
myproxy/source/VERSION:155:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6789)
myproxy/source/VERSION:157:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7133)
myproxy/source/VERSION:159:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7135)
myproxy/source/VERSION:161:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7139)
myproxy/source/VERSION:171:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7151)
myproxy/source/VERSION:184:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7103)
myproxy/source/VERSION:189:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7098)
myproxy/source/VERSION:193:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7119)
myproxy/source/VERSION:195:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7111)
myproxy/source/VERSION:204:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7039)
myproxy/source/VERSION:207:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7033)
myproxy/source/VERSION:210:    flavor (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=7048)
myproxy/source/VERSION:217:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6983)
myproxy/source/VERSION:219:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6963)
myproxy/source/VERSION:226:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6897)
myproxy/source/VERSION:228:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6909)
myproxy/source/VERSION:232:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6882)
myproxy/source/VERSION:234:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6957)
myproxy/source/VERSION:236:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6959)
myproxy/source/VERSION:242:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6903)
myproxy/source/VERSION:259:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6889)
myproxy/source/VERSION:263:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6886)
myproxy/source/VERSION:274:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6878);
myproxy/source/VERSION:289:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6786)
myproxy/source/VERSION:292:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6847)
myproxy/source/VERSION:295:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6807)
myproxy/source/VERSION:297:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6849)
myproxy/source/VERSION:299:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6852)
myproxy/source/VERSION:308:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6713)
myproxy/source/VERSION:310:    (http://bugzilla.globus.org/globus/show_bug.cgi?id=6648)
myproxy/source/VERSION:323:    (http://bugzilla.globus.org/globus/show_bug.cgi?id=6717)
myproxy/source/VERSION:331:    (http://bugzilla.globus.org/globus/show_bug.cgi?id=6723)
myproxy/source/VERSION:342:    (http://bugzilla.globus.org/globus/show_bug.cgi?id=5899)
myproxy/source/VERSION:346:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6324)
myproxy/source/VERSION:355:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6630)
myproxy/source/VERSION:357:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6612)
myproxy/source/VERSION:364:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6623)
myproxy/source/VERSION:383:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6488)
myproxy/source/VERSION:385:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6436)
myproxy/source/VERSION:387:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6561)
myproxy/source/VERSION:389:    atomically (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6432)
myproxy/source/VERSION:421:    errors (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6325)
myproxy/source/VERSION:424:    (http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=5627)
myproxy/source/gsi_socket.c:389:#if 0 /* http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6909 */
myproxy/source/myproxy-test:1666:#     (http://bugzilla.globus.org/globus/show_bug.cgi?id=1914)
packaging/debian/globus-gram5/debian/control:7:Homepage: http://www.globus.org/
packaging/debian/globus-data-management-server/debian/control:7:Homepage: http://www.globus.org/
packaging/debian/globus-resource-management-client/debian/control:7:Homepage: http://www.globus.org/
packaging/debian/globus-resource-management-sdk/debian/control:7:Homepage: http://www.globus.org/
packaging/debian/globus-data-management-client/debian/control:7:Homepage: http://www.globus.org/
packaging/debian/globus-gsi/debian/control:7:Homepage: http://www.globus.org/
packaging/debian/globus-data-management-sdk/debian/control:7:Homepage: http://www.globus.org/
packaging/debian/myproxy/debian/changelog.in:345:  * Fix http://jira.globus.org/browse/GT-355: Myproxy-server init script problems on debian
packaging/debian/globus-gridftp/debian/control:7:Homepage: http://www.globus.org/
packaging/debian/globus-resource-management-server/debian/control:7:Homepage: http://www.globus.org/
packaging/debian/gridftp-hdfs/debian/control:8:Homepage: http://www.globus.org/
packaging/debian/gridftp-hdfs/debian/copyright:3:Source: http://toolkit.globus.org/ftppub/gt6/packages/gridftp_hdfs-1.2.tar.gz
packaging/debian/gridftp-hdfs/debian/copyright:6:Upstream-Authors: The Globus Alliance - http://www.globus.org/
support-changes.md:50:* globus-url-copy (GridFTP client): Transition to using the [Globus CLI](https://docs.globus.org/cli/) or [Python SDK](https://globus-sdk-python.readthedocs.io) to transfer data via the Globus cloud transfer service.
support-changes.md:51:* GSI: Globus Auth provides a more modern, secure, web-friendly, OAuth2-based security approach than the 1990s-era X.509 of GSI. See https://docs.globus.org/api/auth/ for more information.
xio/drivers/udt/source/udt/Makefile.am:3:udt_tarball_url = http://toolkit.globus.org/ftppub/gt6/packages/$(udt_tarball)

@matyasselmeci
Copy link
Contributor Author

The bugzilla links are dead so we can remove those.

@fscheiner
Copy link
Member

The bugzilla links are dead so we can remove those.

Sure they're dead, but should we really remove them from a changelog like file (which BTW also contains other non-working links to bugzilla.mcs.anl.gov)?

I'm also struggling with the following two occurences:

myproxy/source/gsi_socket.c:389:#if 0 /* http://bugzilla.globus.org/bugzilla/show_bug.cgi?id=6909 */
myproxy/source/myproxy-test:1666:#     (http://bugzilla.globus.org/globus/show_bug.cgi?id=1914)

The first one seems to have been meant as explanation for the conditional. Granted the linked information does no longer exist, but if we remove the URL, there's no hint left what that conditional was meant for. With the link retained one can at least conclude that it's there because of a bug.

The second one seems to be similar but at least has also some explanatory text close by.

@fscheiner
Copy link
Member

@ellert
There are still references to [...]globus.org in some Debian packaging files. These correspond to the "virtual" packages that only contain dependencies AFAICS (e.g. globus-gram5, globus-data-mamagement-server and others). These are not build for Debian, right? And as I also can't find the corresponding RPM packages for EPEL, should we get rid of these (both for Fedora/EPEL and Debian)? This will also require changes to the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@msalle @ellert @fscheiner @matyasselmeci