Skip to content

Commit

Permalink
update links to rseng
Browse files Browse the repository at this point in the history
Signed-off-by: vsoch <vsoch@users.noreply.github.com>
  • Loading branch information
vsoch committed Mar 13, 2022
1 parent 83b3487 commit 8e420b9
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 19 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ cases, such as:

![img/recommend-o-matic-docs.png](img/recommend-o-matic-docs.png)

To get started, read the [documentation](https://stanford-rc.github.io/recommend-o-matic/) served alongside the repository,
or jump right into the [demo](https://stanford-rc.github.io/recommend-o-matic/demo/stanford-compute-grid/).
To get started, read the [documentation](https://rseng.github.io/recommend-o-matic/) served alongside the repository,
or jump right into the [demo](https://rseng.github.io/recommend-o-matic/demo/stanford-compute-grid/).

## Possible Features

The following features would be fairly easy to do! [Let me know](https://github.com/stanford-rc/recommend-o-matic/issues)
The following features would be fairly easy to do! [Let me know](https://github.com/rseng/recommend-o-matic/issues)
if you'd like to request or work on one.

- **GitHub Workflow**: It would be fairly easy to create a workflow to download a set of sheets, validate and generate updated data, and then deploy an updated interface. If you are interested in automation, this feature would be useful to you.
- **Sorting**: Currently, rows are not sortable, but they could be (based on group or category)
- **Labels**: An additional level of labels (also based on group or category) could be used to help visually group.

And of course, if you have ideas or feedback, don't hesitate to [open an issue](https://github.com/stanford-rc/recommend-o-matic/issues)!
And of course, if you have ideas or feedback, don't hesitate to [open an issue](https://github.com/rseng/recommend-o-matic/issues)!
2 changes: 1 addition & 1 deletion data/recommend-o-matic.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# recommend-o-matic tool to validate and parse exports to generate json for
# the Recommend-o-matic web interface. Use reccommend-o-matic --help
# for usage, or see the project README https://github.com/stanford-rc/recommend-o-matic
# for usage, or see the project README https://github.com/rseng/recommend-o-matic

import argparse
import json
Expand Down
24 changes: 12 additions & 12 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ cases, such as:
- Compute
- Storage

To get started, continue reading here, or read the [documentation](https://stanford-rc.github.io/recommend-o-matic/) served alongside the repository.
To get started, continue reading here, or read the [documentation](https://rseng.github.io/recommend-o-matic/) served alongside the repository.

## 1. How do I prepare resources and questions?

Expand All @@ -17,8 +17,8 @@ a workflow that has collaborative editing done in Google Sheets, and then
export of those sheets to a tab separated file. As an example, you might want the
following two sheets:

- [ComputeResources.tsv](https://github.com/stanford-rc/recommend-o-matic/blob/master/data/ComputeResources.tsv)
- [ComputeQuestions.tsv](https://github.com/stanford-rc/recommend-o-matic/blob/master/data/ComputeQuestions.tsv)
- [ComputeResources.tsv](https://github.com/rseng/recommend-o-matic/blob/main/data/ComputeResources.tsv)
- [ComputeQuestions.tsv](https://github.com/rseng/recommend-o-matic/blob/main/data/ComputeQuestions.tsv)

Details for each are provided below.

Expand All @@ -35,8 +35,8 @@ This sheet should include listing of resources matched (via unique_id) to the qu
### Sheets Instructions

The following instructions are for how to create the sheets! You can look at the *.tsv examples in
[data](https://github.com/stanford-rc/recommend-o-matic/blob/master/data), and the following points can be useful to answer any additional questions you might have.
If you have a question not addressed here, please [open an issue](https://github.com/stanford-rc/recommend-o-matic/issues)
[data](https://github.com/rseng/recommend-o-matic/blob/main/data), and the following points can be useful to answer any additional questions you might have.
If you have a question not addressed here, please [open an issue](https://github.com/rseng/recommend-o-matic/issues)

* Add questions about your resources to the ComputeQuesitons tab. For each question, the unique_id will be used in the ComputeResources tab to reference the question
* Each question should have a comma separated list of possible options. This list will be validated when the data is parsed.
Expand Down Expand Up @@ -78,7 +78,7 @@ actions:
### Validate and Generate

Here is how we would provide the questions and resources to the script, all located under
[data](https://github.com/stanford-rc/recommend-o-matic/blob/master/data/ComputeQuestions.tsv):
[data](https://github.com/rseng/recommend-o-matic/blob/main/data/ComputeQuestions.tsv):

```bash
$ python data/recommend-o-matic.py generate --questions data/ComputeQuestions.tsv --resources data/ComputeResources.tsv
Expand Down Expand Up @@ -173,7 +173,7 @@ there is either a typo, or that the new answer should be added as a valid answer

## 4. How do I create and deploy the interface?

You can look at the [index.html](https://github.com/stanford-rc/recommend-o-matic/blob/master/docs/demo/stanford-compute-grid/index.html) provided in the repository to see how it works (or use as a template to get started).
You can look at the [index.html](https://github.com/rseng/recommend-o-matic/blob/main/docs/demo/stanford-compute-grid/index.html) provided in the repository to see how it works (or use as a template to get started).
Generally, you will want to add style sheets (css), scripts (JavaScript) and then a div
for the component. Note that the component is under development, so the assets are statically linked
to the "dist" folder in the root from one of the demo folders to not have redundancy. We
Expand Down Expand Up @@ -218,7 +218,7 @@ the recommend-o-matic component. That looks like this:
```

And then finally, to instantiate the component with our data file generated by
the [steps outlined above](https://stanford-rc.github.io/recommend-o-matic/#/?id=_2-how-do-i-generate-data-for-the-interface),
the [steps outlined above](https://rseng.github.io/recommend-o-matic/#/?id=_2-how-do-i-generate-data-for-the-interface),
we can load the json and provide the lodaded data to it as the "data" attribute.
An example of how to specify another option is shown for divid.

Expand Down Expand Up @@ -259,8 +259,8 @@ as you'd want (e.g., you likely want to define `background-color`). For defaults

Since this is highly under development, we have several demos!

- [vertical layout (version 1)](https://stanford-rc.github.io/recommend-o-matic/demo/vertical-layout/) was the original version, and it was hard to see both options and the table at the same time.
- [horizonal layouy (version 2)](https://stanford-rc.github.io/recommend-o-matic/demo/horizontal-layout/) moved the questions to the side of the table, making it easier to see both.
- [simple layout (version 3)](https://stanford-rc.github.io/recommend-o-matic/demo/stanford-compute/) takes the stance that the table is too large and busy, and we want to make it more compact.
- [grid layout (version 4)](https://stanford-rc.github.io/recommend-o-matic/demo/stanford-compute-grid/) too many cooks spoil the soup! For this version I threw away our current prototype and updated it to be as I think it might look nice.
- [vertical layout (version 1)](https://rseng.github.io/recommend-o-matic/demo/vertical-layout/) was the original version, and it was hard to see both options and the table at the same time.
- [horizonal layouy (version 2)](https://rseng.github.io/recommend-o-matic/demo/horizontal-layout/) moved the questions to the side of the table, making it easier to see both.
- [simple layout (version 3)](https://rseng.github.io/recommend-o-matic/demo/stanford-compute/) takes the stance that the table is too large and busy, and we want to make it more compact.
- [grid layout (version 4)](https://rseng.github.io/recommend-o-matic/demo/stanford-compute-grid/) too many cooks spoil the soup! For this version I threw away our current prototype and updated it to be as I think it might look nice.

4 changes: 2 additions & 2 deletions docs/_coverpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ section.cover .cover-main>p:last-child a {
}
</style>

[GitHub](https://github.com/stanford-rc/recommend-o-matic/)
[GitHub](https://github.com/rseng/recommend-o-matic/)
[Get Started](#recommend-o-matic)
[Demo](https://stanford-rc.github.io/recommend-o-matic/demo/stanford-compute-grid/)
[Demo](https://rseng.github.io/recommend-o-matic/demo/stanford-compute-grid/)

0 comments on commit 8e420b9

Please sign in to comment.