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

Updates - AUK Documentation #47

Merged
merged 10 commits into from
Jul 6, 2018
Merged

Updates - AUK Documentation #47

merged 10 commits into from
Jul 6, 2018

Conversation

SamFritz
Copy link
Member

This pull request updates the AUK documentation page.

Task list:

  • update images 2-4 to reflect changes in AUK
  • add in a description about GraphPass and log-transformations
  • create tooltip/footer/ insert short description about what a logarithmic transformation is @ianmilligan1, @greebie, @SamFritz collaborated to create a cohesive description.

Notes:

  • only the 2nd image changed; need to wait for AUK to finish analyzing collections to update images 3 & 4
  • a decision was reached to insert short description of log-transformation at end of GraphPass section. We will be using this text as part of a tooltip at https://cloud.archivesunleashed.org

@ianmilligan1
Copy link
Member

Now that we've merged the new docs over in the auk repo, I think we just need to update the screenshots here and we're good to do a final review and make this live as well?

* A GEXF file which you can load with Gephi. It has a basic layout courtesy of our [Graphpass](https://github.com/archivesunleashed/graphpass) program, which allows you to see major nodes and communities in the network;
* A GraphML file which you can load with [Gephi](https://gephi.org/). It does not have any basic layouts or transformations, requiring you to do so manually. You can use Graphpass to provide layout if you wish to add that feature to your file;
* A GEXF file which you can load with Gephi. It has a basic layout courtesy of our [GraphPass](https://github.com/archivesunleashed/graphpass) program, which allows you to see major nodes and communities in the network;
* A GraphML file which you can load with [Gephi](https://gephi.org/). It does not have any basic layouts or transformations, requiring you to do so manually. You can use GraphPass to provide layout if you wish to add that feature to your file;
Copy link
Member

Choose a reason for hiding this comment

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

Provide a link to GraphPass here.

@@ -31,27 +31,44 @@ In addition, AUK's [documentation](http://cloud.archivesunleashed.org/documentat

Let's take a tour of how AUK works. Once a user signs up to [cloud.archivesunleashed.org](http://cloud.archivesunleashed.org/), they enter their Archive-It credentials, which are salted and encrypted. Those credentials are then used to sync their Archive-It collections with AUK using Archive-It's [WASAPI](https://github.com/WASAPI-Community/data-transfer-apis) endpoint. This is done as a background job, and once it is complete, it emails the user to let them know that their Archive-It collections are synced and available for further analysis on their dashboard.

The AUK dashboard provides some basic information about each collection: title, if it is publicly available (in Archive-It), the number of ARC/WARCs in the collection, and the size of the collection. You can see this below!
The AUK dashboard provides some basic information about each collection: title, if the collection has been analyzed in AUK yet, if it is publicly available (in Archive-It), the number of ARC/WARCs in the collection, and the size of the collection. You can see this below!
Copy link
Member

Choose a reason for hiding this comment

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

Dashboard or collection? We had a bit of this conversation on the auk PR.


![Cloud collections](/images/collections.png)

Copy link
Member

Choose a reason for hiding this comment

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

Remove single space.

@ruebot ruebot merged commit c23e130 into master Jul 6, 2018
@ruebot ruebot deleted the updates branch July 6, 2018 13:39
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

Successfully merging this pull request may close these issues.

None yet

3 participants