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

Dead Links #43

Open
Juergeen opened this issue Dec 19, 2015 · 3 comments
Open

Dead Links #43

Juergeen opened this issue Dec 19, 2015 · 3 comments

Comments

@Juergeen
Copy link

In https://github.com/Kinetic/kinetic-c/blob/master/DEVELOP.md etc., there are dead links to seagate.github.io (returning HTTP 404 errors).

@pnavneet
Copy link

pnavneet commented Jan 7, 2016

Below links are also pointing to seagate.github.io (HTTP 404 errors)
Basically API documentation links.

http://seagate.github.io/kinetic-c/kinetic__client_8h.html

@barneywilliams
Copy link
Contributor

I believe the process of generating the API docs isn't part of the TravisCI
build, so it needs to be done manually as part of the release process. I
will see if I can get that updated and will communicate to the devs for
better maintenance long-term.

Greg Williams
Software Consultant & Developer
Atomic Object http://www.atomicobject.com
The right software can change everything.

On Thu, Jan 7, 2016 at 5:12 AM, pnavneet [email protected] wrote:

Below links are also pointing to seagate.github.io (HTTP 404 errors)
Basically API documentation links.

http://seagate.github.io/kinetic-c/kinetic__client_8h.html


Reply to this email directly or view it on GitHub
#43 (comment).

@barneywilliams
Copy link
Contributor

The doxygen API generation is currently included in the Rakefile, and must be executed from there.

Assuming doxygen is installed, anyone can generate the docs locally:
rake doxygen:gen

In order to update the public version of the docs, which is usually done as part of the release process, someone with push access must do:
rake doxygen:update_public_api

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants