Skip to content
This repository has been archived by the owner on Mar 22, 2022. It is now read-only.

[BOUNTY] Directory page UI improvements #38

Merged
merged 8 commits into from
Jul 23, 2020

Conversation

neatonk
Copy link
Contributor

@neatonk neatonk commented Jul 7, 2020

BOUNTY details: #37
This is a dependency of ipfs/kubo#7536

This PR implements the changes described in #37.

This is an incremental improvement over the previous version of the dir-index.html page and I suggest that a larger restructuring of the page should be considered after this PR is completed. Additional changes informed by a discussion of design constraints (e.g. file size and responsiveness) and developer workflow (e.g. build tools and minification) would lead to greater improvements.

Screen Shot 2020-07-07 at 09 24 38
Screen Shot 2020-07-07 at 09 24 45
Screen Shot 2020-07-07 at 09 25 00
Screen Shot 2020-07-07 at 09 25 09
Screen Shot 2020-07-07 at 09 26 23

Closes #37

@welcome
Copy link

welcome bot commented Jul 7, 2020

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions
    and stakeholders linked/mentioned.

  • Your contribution itself is clear (code comments, self-review for the
    rest) and in its best form. Follow the code contribution
    guidelines

    if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on
    any missing things and potentially assigning a reviewer for high
    priority items.

  • The PR gets reviews, discussed and approvals as needed.

  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

@jessicaschilling
Copy link
Contributor

Thanks, @neatonk!

This looks good to me but I'd like to have a closer review by the go-ipfs core team. @aschmahmann -- do you have the time, or can you suggest another reviewer?

@jessicaschilling
Copy link
Contributor

@aschmahmann -- just to note, this behaves as intended (meets all the criteria in #37 (comment) ) using the test server described here.

I'm afraid I can't explicitly confirm/deny that the test info gives us enough confidence to merge. Is this something that you or @Stebalien can investigate? Apologies for the inconvenience.

Copy link
Contributor

@jessicaschilling jessicaschilling left a comment

Choose a reason for hiding this comment

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

As noted in #38 (comment) -- this meets all the requirements using the test server, but I still would like @aschmahmann or @Stebalien to confirm that we're confident to merge.

test/main.go Show resolved Hide resolved
@aschmahmann aschmahmann added the status/blocked Unable to be worked further until needs are met label Jul 10, 2020
@jessicaschilling
Copy link
Contributor

It wasn’t in the original bounty spec - however, @neatonk, is that something you could take on? We may be able to adjust the bounty as a result.

The presence of additional content in the table was causing the width of the
type-icon column to be reduced. Applying the width to the column and it's
contents prevents this from happening.
Copy link
Contributor

@jessicaschilling jessicaschilling left a comment

Choose a reason for hiding this comment

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

One quick note -- can you please make the changes you made in dir-index.html in dir-index-uncat.html as well? Thank!

dir-index.html Outdated Show resolved Hide resolved
@neatonk
Copy link
Contributor Author

neatonk commented Jul 14, 2020

@jessicaschilling Is dir-index-uncat.html actually in use? If not, I would prefer to leave it alone. It is not clear how the changes I made should be applied and for what purpose.

@jessicaschilling
Copy link
Contributor

They are both in use, unfortunately. https://github.com/ipfs/dir-index-html#updating does include guidance to touch them both when updating, but this also could have been called out more explicitly in the issue; that's my fault.

@neatonk
Copy link
Contributor Author

neatonk commented Jul 15, 2020

No worries and thanks for pointing that out. However, it looks to me like the two files are already out of sync. That will make it difficult for me to update dir-index-uncat.html to include the changes in this PR.

Below are two possible solutions to this problem. I am in favor of Option B since it would be a better use of time and would not delay this PR.

Option A

First, tap someone who is familiar with previous changes to dir-index.html and ask them to update dir-index-uncat.html to reflect those changes and commit the result. Then I can rebase my branch to include that commit and update dir-index-uncat.html to reflect the changes in this PR.

Option B

Finalize this PR (and bounty) without updating dir-index-uncat.html. Plan to correct this later by building dir-index.html from dir-index-uncat.html (possibly via #6). This is essentially what I was alluding to when I mentioned "developer workflow" above.

@jessicaschilling
Copy link
Contributor

jessicaschilling commented Jul 15, 2020

Option B is fine. I'll need to rationalize the two files at a later date before we can release this, but if you're able to get everything working and tested for dir-index.html that's a start.

Agreed that automating as in #6 is the best long-term solution, but we've not got anyone with the bandwidth for that at present.

dir-index.html Show resolved Hide resolved
@jessicaschilling jessicaschilling merged commit 354f12b into ipfs:master Jul 23, 2020
Copy link
Member

@lidel lidel left a comment

Choose a reason for hiding this comment

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

👍 let's continue in ipfs/kubo#7536

@jessicaschilling
Copy link
Contributor

Also branch chore/reconcile-uncat

@jessicaschilling jessicaschilling removed the status/blocked Unable to be worked further until needs are met label Jul 24, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BOUNTY] Directory page UI improvements
4 participants