26 - Add frontend guides #353

MellyGray · 2024-03-25T12:20:02Z

What this PR does / why we need it:

This issue adds a basic Frontend Guide. Which will be extended in future issues to add different sections in more detail.

Which issue(s) this PR closes:

Closes [Docs] Dataverse Frontend Guide #26

Special notes for your reviewer:

This issue was started by Mathew, but he left the project midway, so I finished some of the TODOs.

Suggestions on how to test this:

Visual inspection of the changed files from the README

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No

Is there a release notes update needed for this change?:

New Frontend Guide

Additional documentation:

…idea of information needed readme badge updates readme updating misc Readme updates

README.md

pdurbin

I ran out of steam once I hit the bit README but here's some quick feedback.

pdurbin · 2024-03-25T17:37:44Z

.github/SUPPORT.md

+
+# Looking for support? We want to help
+
+Please post your question to X (#) using the Timber tag.


What is this X/Timber stuff?

I removed the SUPPORT.md file because the file seemed like a template with no real information, and we already cover the various channels through which people can contact us in the README, such as Google Groups, Zulip, etc.

pdurbin · 2024-03-25T17:38:56Z

.github/SUPPORT.md

+
+## Other places
+
+You can use [GitHub Discussions](#) to open up questions and engage in discussions with the contributors and other users.


Do we plan to use GitHub Discussion? That's fine. I'm just curious. 😄

I asked the frontend team, and for the moment, we'll stick with Zulip.

pdurbin · 2024-03-25T17:39:27Z

.github/SUPPORT.md

+
+You can use [GitHub Discussions](#) to open up questions and engage in discussions with the contributors and other users.
+
+Please don't post to the [EXAMPLE forum](#). You might see a response, but it will just redirect you to either GitHub (for bugs/issues) or StackOverflow (for usage/support questions).


Do we need this line? Don't post somewhere? Stackoverflow? 🤔

I removed the SUPPORT.md file because the file seemed like a template with no real information, and we already cover the various channels through which people can contact us in the README, such as Google Groups, Zulip, etc.

pdurbin · 2024-03-25T17:43:45Z

AUTHORS.md

+# Thanks to everyone for your contributions!
+
+Harvard University IQSS Team
+FirstName LastName <[email protected]>


I'm just curious where this AUTHORS file idea came from. I do see Sinatra uses it according to https://opensource.guide/building-community/#share-ownership-of-your-project via https://stackoverflow.com/questions/18459504/what-is-the-origin-and-purpose-of-authors-md

I'm not opposed to it. Again, just curious.

There's also CODEOWNERS: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

And there's All Contributors, which @poikilotherm is playing around with here:

Initialize AllContributors Bot gdcc/dvopa#1

I removed the file for now since it was just a template that needs to be filled with real information.

There's an issue to work on it:

[Docs] General OSS Project documentation #306

However, at the moment, it doesn't seem like a critical file in the Frontend Guides, and we have some other issues related to the frontend guides in this Sprint with higher priority than the AUTHORS file.

[Spike - Developer Guide] Breakdown of architecture design methodology #315

pdurbin · 2024-03-25T17:46:16Z

CHANGELOG.md

+Resources for generating a changelog:
+
+[skywinder/Github-Changelog-Generator](https://github.com/skywinder/Github-Changelog-Generator) - generates a full changelog that overwrites the existing CHANGELOG.md.
+
+[hzalaz/wt-oss-milestone-changelog](https://github.com/hzalaz/wt-oss-milestone-changelog) - generates a snippet of Markdown that can be added to a CHANGELOG.md.
+
+[conventional-changelog/conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli) - generates a full changelog based on commit history with the option to append to an existing changelog.


I'd suggest moving these elsewhere for the final changelog.

There's also https://keepachangelog.com (not for generating, but just a high level of why a changelog is a good idea).

pdurbin · 2024-03-25T17:47:32Z

CODE_OF_CONDUCT.md

@@ -0,0 +1,142 @@
+# Dataverse&reg; Code of Conduct


Shouldn't the Code of Conduct be the same as https://github.com/IQSS/dataverse/blob/develop/CODE_OF_CONDUCT.md ? (It's what we link to from https://dataverse.org as well.)

Done! I replaced it with the CODE_OF_CONDUCT from the main Dataverse repo

pdurbin · 2024-03-25T17:49:22Z

CONTRIBUTING.md

+
+## Documenting
+
+This is probably one of the most important things you can do as a contributor and probably one of the easiest things you can do. There are two big pieces of documentation you can edit right here on github!


Suggested change

This is probably one of the most important things you can do as a contributor and probably one of the easiest things you can do. There are two big pieces of documentation you can edit right here on github!

This is probably one of the most important things you can do as a contributor and probably one of the easiest things you can do. There are two big pieces of documentation you can edit right here on GitHub!

pdurbin · 2024-03-25T17:50:16Z

CONTRIBUTING.md

+
+Hey there! We’re really happy you’ve found your way here. Dataverse&reg; is a community project that is developed by people from all over the world. We appreciate any help.
+
+Before you start working on something we would suggest talking to us in the [TODO: discussion forum](#) or asking a question on [TODO: GoogleGroups/Zulip](#). You can also contact us via the chat widget on the [TODO: main Dataverse website](#).


Just pointing out that there are a number of TODO's in the doc, including this one.

I addressed all the TODOs in the CONTRIBUTING.md file. Well, I mostly rewrote it, taking the CONTRIBUTING.md file from the main Dataverse repository as a reference. I also added the DEVELOPER_GUIDE.md file for more information about code contributions

pdurbin · 2024-03-25T17:51:45Z

CONTRIBUTING.md

+
+## Ownership
+
+By contributing code you are granting _(`Dataverse`)_ shared ownership of your work. You still own it but _(`Dataverse`)_ will have the right to relicense your work based on our needs & treat this work as if it was developed by a _(`Dataverse`)_ engineer.


Is this legalese correct?

No idea, I just removed that part and used the Dataverse main repository's CONTRIBUTING file as a reference.

MellyGray · 2024-03-27T13:11:23Z

Moving this back to in progress because there are a number of TODOs

…erse repo

…st-cases 326 - Developer guide - Writing test cases

coveralls · 2024-03-28T19:22:24Z

coverage: 97.694%. remained the same
when pulling a3fa006 on docs/26-add-frontend-guides
into 3aa4685 on develop.

…into docs/26-add-frontend-guides

DEVELOPER_GUIDE.md

ekraffmiller

Looks good! I just have a few comments

DEVELOPER_GUIDE.md

…into docs/26-add-frontend-guides

MellyGray · 2024-04-16T10:11:33Z

@ekraffmiller thanks for your comments. I addressed the changes!

ekraffmiller

Thanks @MellyGray for your changes, I just found one small thing from the merge to look at

ekraffmiller · 2024-04-16T16:58:07Z

README.md

+<<<<<<< HEAD
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+<br>
+=======
 We have introduced an update to the breadcrumb navigation UI. Unlike in the original JSF application, where breadcrumbs
 did not reflect the user's current location within the site, our new SPA design now includes this feature in the breadcrumbs.
 Additionally, we have aligned with best practices by positioning all breadcrumbs at the top, before anything else in the UI.
+>>>>>>> 3aa4685da974fdc9328c44866237bd8173e31cda


It looks like this is from a merge conflict, can it be deleted?

Good thing you noticed that! Thanks!

ekraffmiller

LGTM!

26 - Add frontend guides

Matt Mangan and others added 11 commits February 28, 2024 15:52

first commit, adding temp files, placeholder content, and getting an …

851c669

…idea of information needed readme badge updates readme updating misc Readme updates

Readme Formatting

efdc807

More readme updates

727deba

test codeblock formatting

94ba941

formatting, links, logo tests

af3e426

formatting, removing second logo

970bb84

formatting

d1c99b1

adding logos, fixing links

ae5db42

feat(Developer Guide): add Writting test cases section

7731842

feat(Developer Guide): add Coverage section

abbd345

feat(Developer Guide): add some notes about Writing test cases

1220a7d

MellyGray linked an issue Mar 25, 2024 that may be closed by this pull request

[Docs] Dataverse Frontend Guide #26

Closed

1 task

MellyGray marked this pull request as ready for review March 25, 2024 12:28

MellyGray mentioned this pull request Mar 25, 2024

326 - Developer guide - Writing test cases #349

Merged

MellyGray commented Mar 25, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

MellyGray added 2 commits March 25, 2024 13:53

feat(Developer Guide): move React Testing Library link

b509e4a

feat(Developer Guide): add missing details closing tag

6d2c130

pdurbin reviewed Mar 25, 2024

View reviewed changes

MellyGray added Size: 10 A percentage of a sprint. 7 hours. and removed Size: 3 A percentage of a sprint. 2.1 hours. labels Mar 27, 2024

MellyGray marked this pull request as draft March 27, 2024 13:12

MellyGray self-assigned this Mar 27, 2024

MellyGray and others added 2 commits March 27, 2024 15:46

feat(Frontend Guides): add the same CODE_OF_CONDUCT as the main Datav…

89713d6

…erse repo

Merge pull request #349 from IQSS/docs-326-developer-guide-writing-te…

98ba0bb

…st-cases 326 - Developer guide - Writing test cases

MellyGray added 3 commits April 1, 2024 16:19

Merge branch 'develop' of https://github.com/IQSS/dataverse-frontend …

75ed003

…into docs/26-add-frontend-guides

feat(Developer Guide): add note about .npmrc.example

60b6af2

feat(Developer Guide): remove unused links

c54082a

MellyGray commented Apr 1, 2024

View reviewed changes

DEVELOPER_GUIDE.md Show resolved Hide resolved

MellyGray marked this pull request as ready for review April 1, 2024 14:45

feat(Frontend Guides): fix .github files to create issues

07fb761

MellyGray removed their assignment Apr 1, 2024

ekraffmiller self-assigned this Apr 15, 2024

ekraffmiller reviewed Apr 15, 2024

View reviewed changes

DEVELOPER_GUIDE.md Show resolved Hide resolved

DEVELOPER_GUIDE.md Show resolved Hide resolved

DEVELOPER_GUIDE.md Show resolved Hide resolved

ekraffmiller assigned MellyGray and unassigned ekraffmiller Apr 15, 2024

MellyGray added 4 commits April 16, 2024 11:58

feat(Frontend Guides): fix Typescript style guide link

c9fedaa

feat(Frontend Guides): add GitHub container registry link

8824d90

feat(Fronted Guides): link e2e new issue to address the failures

abbb137

Merge branch 'develop' of https://github.com/IQSS/dataverse-frontend …

f89980a

…into docs/26-add-frontend-guides

MellyGray assigned ekraffmiller and unassigned MellyGray Apr 16, 2024

ekraffmiller requested changes Apr 16, 2024

View reviewed changes

ekraffmiller assigned MellyGray and unassigned ekraffmiller Apr 16, 2024

fix: merge conflict arrows

a3fa006

MellyGray assigned ekraffmiller and unassigned MellyGray Apr 17, 2024

ekraffmiller approved these changes Apr 17, 2024

View reviewed changes

ekraffmiller removed their assignment Apr 17, 2024

g-saracca merged commit 5107f18 into develop Apr 17, 2024
13 of 14 checks passed

g-saracca deleted the docs/26-add-frontend-guides branch April 17, 2024 18:11

cmbz mentioned this pull request May 3, 2024

Epic: GREI - Dataverse Rearchitecture IQSS/dataverse-pm#123

Open

jayanthkomarraju pushed a commit to jayanthkomarraju/dataverse-frontend that referenced this pull request May 31, 2024

Merge pull request IQSS#353 from IQSS/docs/26-add-frontend-guides

ec840e4

26 - Add frontend guides

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

26 - Add frontend guides #353

26 - Add frontend guides #353

MellyGray commented Mar 25, 2024 •

edited

Loading

pdurbin left a comment

pdurbin Mar 25, 2024

MellyGray Apr 1, 2024

pdurbin Mar 25, 2024

MellyGray Apr 1, 2024

pdurbin Mar 25, 2024

MellyGray Apr 1, 2024

pdurbin Mar 25, 2024

MellyGray Apr 1, 2024

pdurbin Mar 25, 2024

pdurbin Mar 25, 2024

MellyGray Apr 1, 2024

pdurbin Mar 25, 2024

pdurbin Mar 25, 2024

MellyGray Apr 1, 2024

pdurbin Mar 25, 2024

MellyGray Apr 1, 2024

MellyGray commented Mar 27, 2024

coveralls commented Mar 28, 2024 •

edited

Loading

ekraffmiller left a comment

MellyGray commented Apr 16, 2024

ekraffmiller left a comment

ekraffmiller Apr 16, 2024

MellyGray Apr 17, 2024

ekraffmiller left a comment


		# Looking for support? We want to help

		Please post your question to X (#) using the Timber tag.


		## Other places

		You can use [GitHub Discussions](#) to open up questions and engage in discussions with the contributors and other users.


		You can use [GitHub Discussions](#) to open up questions and engage in discussions with the contributors and other users.

		Please don't post to the [EXAMPLE forum](#). You might see a response, but it will just redirect you to either GitHub (for bugs/issues) or StackOverflow (for usage/support questions).


		## Documenting

		This is probably one of the most important things you can do as a contributor and probably one of the easiest things you can do. There are two big pieces of documentation you can edit right here on github!


		Hey there! We’re really happy you’ve found your way here. Dataverse® is a community project that is developed by people from all over the world. We appreciate any help.

		Before you start working on something we would suggest talking to us in the [TODO: discussion forum](#) or asking a question on [TODO: GoogleGroups/Zulip](#). You can also contact us via the chat widget on the [TODO: main Dataverse website](#).


		## Ownership

		By contributing code you are granting _(`Dataverse`)_ shared ownership of your work. You still own it but _(`Dataverse`)_ will have the right to relicense your work based on our needs & treat this work as if it was developed by a _(`Dataverse`)_ engineer.

26 - Add frontend guides #353

26 - Add frontend guides #353

Conversation

MellyGray commented Mar 25, 2024 • edited Loading

What this PR does / why we need it:

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?:

Additional documentation:

pdurbin 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

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

MellyGray commented Mar 27, 2024

coveralls commented Mar 28, 2024 • edited Loading

ekraffmiller left a comment

Choose a reason for hiding this comment

MellyGray commented Apr 16, 2024

ekraffmiller left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ekraffmiller left a comment

Choose a reason for hiding this comment

MellyGray commented Mar 25, 2024 •

edited

Loading

coveralls commented Mar 28, 2024 •

edited

Loading