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

URL for new documentation #15

Closed
ruebot opened this issue Oct 26, 2019 · 5 comments
Closed

URL for new documentation #15

ruebot opened this issue Oct 26, 2019 · 5 comments

Comments

@ruebot
Copy link
Member

@ruebot ruebot commented Oct 26, 2019

What do we want to URL for this documentation we're working on to be? Do we want to keep http://docs.archivesunleashed.io?

Currently:

Or, do:

  • archivesunleashed.io ->GitHub org
  • archivesunleashed.io/docs (Landing page for aut documentation)
  • archivesunleashed.io/docs/java (javadocs)
  • archivesunleashed.io/docs/scala (scaladocs)
  • archivesunleashed.io/docs/user (user documentation; this repo)

Or, do we box ourselves in by assuming only aut documentation lives on archivesunleashed.io, so we do:

  • archivesunleashed.io ->GitHub org
  • archivesunleashed.io/aut ->GitHub repo
  • archivesunleashed.io/aut/docs (Landing page for aut documentation)
  • archivesunleashed.io/aut/docs/java (javadocs)
  • archivesunleashed.io/aut/docs/scala (scaladocs)
  • archivesunleashed.io/aut/docs/user (user documentation; this repo)

Also, we do we do with the stub page for aut on archivesunleashed.org? Just leave it as is?

What are y'all's thoughts on how we should structure things once we're ready to "publish" these new docs. Might help with planning out/sketching out future of Notebooks, the Cloud, GraphPass, etc.

@ianmilligan1
Copy link
Member

@ianmilligan1 ianmilligan1 commented Oct 26, 2019

My initial gut feel was "what does Nick think?" 😄

That said, I like the idea of keeping http://docs.archivesunleashed.io and having it bring us to a basic Jekyll page of the Archives Unleashed Toolkit documentation. And the status quo works for me otherwise.

But what do you think, @ruebot ?

@ruebot
Copy link
Member Author

@ruebot ruebot commented Oct 26, 2019

We use archivesunleashed.io for our Java/Scala namespace (and it's what's registered with Maven Central). Ideally, we'd do the third option. But, we don't really have that many projects setup, and since all of our code projects/repos are in some way or another offshoots of aut, I'm fine with keeping the status quo.

Really, I just wanted to put it all out there on the table to make sure we had a conversation about it again, and it's better documented 😃

@ruebot
Copy link
Member Author

@ruebot ruebot commented Jun 3, 2020

@SamFritz can we put this one on the agenda for tomorrow?

My suggestion is going to be docs.archivesunleashed.org or docs.archivesunleashed.org/aut if I can swing it on github pages. I rather not use the io tld given the baggage that comes with it.

@ruebot
Copy link
Member Author

@ruebot ruebot commented Jun 3, 2020

or, aut.docs.archivesunleashed.org. That's actually doable with gh-pages.

ruebot added a commit that referenced this issue Jun 3, 2020
ruebot added a commit that referenced this issue Jun 3, 2020
@ianmilligan1
Copy link
Member

@ianmilligan1 ianmilligan1 commented Jun 6, 2020

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

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.