Add new repositories fragment #803

mpourismaiel · 2020-07-18T16:51:47Z

What this PR does / why we need it:
Added new fragment called "repositories". Demo and documentation is available at /fragments/repositories. Currently it only supports Github. I plan to add Bitbucket and Gitlab shortly but adding them would require a simple interface to keep us from writing the template multiple times. Writing the code isn't that hard but I prefer to get approval on the design and how it's currently implemented before I move on.

Which issue this PR fixes:
fixes #599

Release note:

- repositories: Added new fragment to fetch and display user repositories from Github

stp-ip

Overall not sure if repositories is the best naming choice especially considering we want to switch to provider specific fragments. Should we start with this fragment and name it "repositories_github".

Meaning we would have "/_".
Examples: "tailwind/contact", "contact", "contact_netlify"

I like the simplicity of it pulling in the latest repos from a user. One downside would be, that it would also pull in forks and place them at the top of the page.
Not sure on it being an issue or how to solve it. First idea would be a whitelist. Other data could still be pulled in from Github.

Another option that could also be a separate fragment could be a similar style, but with sub item config configuring git url, repository and project page etc.

With the API usage we could add stars, forks, contributors, issue url, release url etc. automatically in a follow on PR I think.

stp-ip · 2020-07-21T15:35:23Z

assets/styles/_syna.scss

+
+.repositories {
+  .repository {
+    display: flex;
+    justify-content: stretch;
+    align-items: stretch;
+
+    .card {
+      flex: 1;
+    }
+  }
+}


Why add the repositories styles to the global syna config?

stp-ip · 2020-07-21T15:47:18Z

exampleSite/content/fragments/repositories/docs.md

+*type: number*
+*default: updated_at*
+
+The variable name to use for sorting repositories. 


Why "variable name"?

I can't think of a good explanation, not happy with it either. Any suggestions?

stp-ip · 2020-07-21T15:47:25Z

exampleSite/content/fragments/repositories/docs.md

+The number of repositories that will be rendered.
+
+#### sort
+*type: number*


Why is this a number?

Totally my bad.

stp-ip · 2020-07-21T15:47:45Z

exampleSite/content/fragments/repositories/docs.md

+
+#### sort
+*type: number*
+*default: updated_at*


What options are available? Star count? Contributors?

stp-ip · 2020-07-21T15:49:19Z

exampleSite/content/fragments/repositories/index.md

+<div class="alert alert-primary" role="alert">
+{{% md %}}
+For now, we only support Github. You can review the [documentation for their API](https://docs.github.com/en/rest/reference/repos#list-repositories-for-a-user).  
+We will add support for more sevices in the future.


Not with the current configuration adding more services would be possible. It feels quite focussed on github. Adding other services would need more data from the user such as sub items with link to project on say gitlab or github.

We could leave it this simple and make it a first provider fragment: "repositories_github" for example.

So rename the fragment to repositories_github and remove the alert?

I was thinking about adding a provider and framework (or variation) variables instead of naming convention. It's not related to this issue though, just wanted to mention it somewhere since I tend to forget a lot :D

stp-ip · 2020-07-21T15:49:46Z

exampleSite/content/fragments/repositories/repositories.md

+++
+fragment = "repositories"
+weight = 100
+user = "octocat"


We should probably showcase "okkur" for good measure :)

stp-ip · 2020-07-21T15:50:34Z

layouts/partials/fragments/repositories.html

+        <div class="card">
+          <div class="card-body">
+            <h5 class="card-title">{{ .name }}</h5>
+            <h6 class="card-subtitle mb-3 text-muted">{{ printf "Last updated on: %s" (dateFormat "02/01/2006" .updated_at) }}</h6>


Why not use the ISO date format aka "2000-12-31"?

I somehow forgot to use the standard format :D Will update it.

mpourismaiel · 2020-07-22T12:44:23Z

I don't think subitems would be a good idea for this fragment. A whitelist of repositories can be created using a variable, specifying fields is something that is applied on all the cards (I don't think changing the fields per project is a good idea, both design-vise and the confusion that it causes to the end user). Also we can allow a filter function to be written by the user and call that. For example, we write our sort and filter functionality in a helper partials/helpers/repositories_github/fitler.html that returns a filtered list and document how to write new filters. We can keep the sort and count in our code for the sake of simplicity as well.

stp-ip · 2020-07-22T12:56:58Z

Ok so we keep it simple.
Make it the first provider specific fragment.
Adding more buttons from the data as follow on.

So default sorting is just by last commit date.
We should have at least star count as well. Sidequestion there. Does a fork have the same star count as the main repo? If not, then filtering wouldn't be needed. We would just have star count default sort and it would always bubble up the users personal repos and show the 5 most important or so.

Not sure about what you are imagining on the filter side. Care to elaborate? My first thought was just whitelisting of repos as a list.

Thinking about lists. Any reason to not make the "user" not a list? Also is this better to be called "user" or namespace?
It being a list of namespaces for example we could do something like: "okkur, okkur-incubator".

The other option there is to keep it simple and pull in only one namespace/user and the Syna user could always create multiple separate fragments.

mpourismaiel · 2020-07-22T16:21:57Z

Sorting and filtering is a bit of a problem since we can't get pinned repositories and have to rely on sorting and limiting or filtering (based on a whitelist or "no forks" somehow) and again, limiting with count. We can however extract the code we use to filter repositories into a helper file that receives repos as a parameter and returns the new list. Then any user who wishes to change the list to their liking can override that helper, copy it to their website and update its code.

stp-ip · 2020-07-22T16:51:52Z

I would leave advanced sorting and filtering for now, but add these points:

sorting by date (what we have)
sorting by star count (new default)
forks true/false (false by default)
whitelist that only shows repos that match the whitelist (not set by default)

Happy to do the whitelist idea in a separate PR. The others I feel are good things to have here already. Thoughts?

mpourismaiel · 2020-07-22T17:29:39Z

@stp-ip Also updated fragment's name and changed forks to display_forks. I think it's more intuitive.

stp-ip · 2020-07-22T18:37:38Z

exampleSite/content/fragments/repositories_github/docs.md


-**Note:** The variable name is a key in the response of Github's repositories API. Also the sort is done using Hugo's `sort` function.
+**Note:** This value is a key from the response of Github's repositories API. Also the sort is done using Hugo's `sort` function.


So can be any key from the Github response. Nice.

stp-ip

/lgtm

stp-ip · 2020-07-22T18:40:44Z

Let's do the whitelist and maybe additional buttons in a separate PR.

mpourismaiel added 2 commits July 18, 2020 21:21

Add new repositories fragment

2ec558f

Update repositories fragment and add documentation

15cb1b0

mpourismaiel changed the title ~~WIP: Add new repositories fragment~~ Add new repositories fragment Jul 20, 2020

mpourismaiel self-assigned this Jul 20, 2020

mpourismaiel requested a review from stp-ip July 20, 2020 13:31

mpourismaiel added the enhancement label Jul 20, 2020

mpourismaiel added this to the v0.18.0 milestone Jul 20, 2020

stp-ip requested changes Jul 21, 2020

View reviewed changes

mpourismaiel added 3 commits July 22, 2020 22:00

Update repositories fragment to a more useful implementation

4075ed2

Fix i18n issue in nav fragment

9499de1

Update documentation and name of the repositories fragment

ba05bb3

stp-ip reviewed Jul 22, 2020

View reviewed changes

stp-ip approved these changes Jul 22, 2020

View reviewed changes

stp-ip merged commit f5938c9 into okkur:master Jul 22, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new repositories fragment #803

Add new repositories fragment #803

mpourismaiel commented Jul 18, 2020 •

edited

Loading

stp-ip left a comment

stp-ip Jul 21, 2020

stp-ip Jul 21, 2020

mpourismaiel Jul 22, 2020

stp-ip Jul 21, 2020

mpourismaiel Jul 22, 2020

stp-ip Jul 21, 2020

stp-ip Jul 21, 2020

mpourismaiel Jul 22, 2020

stp-ip Jul 21, 2020

stp-ip Jul 21, 2020

mpourismaiel Jul 22, 2020

mpourismaiel commented Jul 22, 2020

stp-ip commented Jul 22, 2020

mpourismaiel commented Jul 22, 2020

stp-ip commented Jul 22, 2020

mpourismaiel commented Jul 22, 2020 •

edited

Loading

stp-ip Jul 22, 2020

stp-ip left a comment

stp-ip commented Jul 22, 2020


		Note: The variable name is a key in the response of Github's repositories API. Also the sort is done using Hugo's `sort` function.
		Note: This value is a key from the response of Github's repositories API. Also the sort is done using Hugo's `sort` function.

Add new repositories fragment #803

Add new repositories fragment #803

Conversation

mpourismaiel commented Jul 18, 2020 • edited Loading

stp-ip left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mpourismaiel commented Jul 22, 2020

stp-ip commented Jul 22, 2020

mpourismaiel commented Jul 22, 2020

stp-ip commented Jul 22, 2020

mpourismaiel commented Jul 22, 2020 • edited Loading

Choose a reason for hiding this comment

stp-ip left a comment

Choose a reason for hiding this comment

stp-ip commented Jul 22, 2020

mpourismaiel commented Jul 18, 2020 •

edited

Loading

mpourismaiel commented Jul 22, 2020 •

edited

Loading