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

remove travis docs, point to OnlinePackage #1244

Closed
wants to merge 1 commit into from
Closed

remove travis docs, point to OnlinePackage #1244

wants to merge 1 commit into from

Conversation

bramtayl
Copy link

Thought this would simplify the manual a bit


generated documentation from the builder to GitHub. The SSH keys can be generated and
submitted with `OnlinePackage.jl`. See the instructions for using that package
[here](https://bramtayl.github.io/OnlinePackage.jl/latest/).
Copy link
Member

@KristofferC KristofferC Feb 19, 2020

Choose a reason for hiding this comment

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

I read through that "documentation" but it is just a bunch of docstrings? I have no idea how I am supposed to use that package. It talks about some User type (what is that), something about deleting a repository (how is that relevant to this?), something about creating a user profile from a toml file where I still should go in and manually generate keys and then create some file locally? And what do I do if my repo is already online?

So far, I am quite unconvinced that this is any clearer and understandable than the existing documentation here that gets deleted. A full walkthrough of the steps required with the same detail as the existing documentation feels appropriate before attempting to delete it.

@mortenpi
Copy link
Member

👍 to mentioning OnlinePackage although, as @KristofferC said, more detailed instructions are always good.

A tangential comment regarding OnlinePackage: I only very briefly glanced at the code, but it looks like it more or less just handles the keys now and is pretty much Documenter-specific? If that is the case, that functionality would also be a good fit for DocumenterTools, if you'd like to merge them.

But either way, we do want to keep the Travis and GITHUB_TOKEN instructions around. The former are still useful for people who are using Travis for CI, and the latter will ideally become the default at some point (possibly soon if #1177 (comment) is true). Plus, it's good to have the logic documented, even if there is a tool that can automate the process.

@bramtayl
Copy link
Author

Ok y'all I hear you. I'll work on writing a detailed tutorial for OnlinePackage. Yes it's pretty SSH key specific; happy to merge into DocumenterTools (I've been pushing for it to get merged into PkgTemplates, but that doesn't seem to be going anywhere). Once that's done I'll edit the PR to just mention OnlinePackage and not delete any docs

@bramtayl
Copy link
Author

Given this #1177 (comment) I think I'll deprecate OnlinePackage

@bramtayl bramtayl closed this Feb 19, 2020
@fredrikekre
Copy link
Member

The functionality to automatically upload the keys might be useful to include in DocumenterTools.

@bramtayl
Copy link
Author

Ok, I can keep it around as long as you'd like. Does anyone know the official process for deprecating packages? Last time I deleted packages it caused chaos...

@fredrikekre
Copy link
Member

fredrikekre commented Feb 19, 2020

You don't have to do anything. You can use GitHub archive feature to make the repo read-only.

@bramtayl
Copy link
Author

Ok

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

Successfully merging this pull request may close these issues.

4 participants