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.

Sign up for GitHub

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

Jump to bottom

Feature Request/Idea: Contributor Guide #10531

Closed
pdurbin opened this issue Apr 26, 2024 · 0 comments · Fixed by #10532
Closed

Feature Request/Idea: Contributor Guide #10531

pdurbin opened this issue Apr 26, 2024 · 0 comments · Fixed by #10532
Labels
Type: Feature a feature request
Milestone
6.3

Comments

@pdurbin
Copy link
Member

pdurbin commented Apr 26, 2024 •
edited
Loading

Overview of the Feature Request

The Contributors UX group met today (attended by @vaidap, @DieuwertjeBloemen, @rtreacy, @ekraffmiller and myself) and we think expanding CONTRIBUTING.md into a proper guide is a good idea.

I offered to stub out the Sphinx files.

What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)

Contributors. A different role than listed above!

What inspired the request?

Discussion of documentation and contribution (notes).

Any open or closed issues related to this feature request?
@pdurbin pdurbin added the Type: Feature a feature request label Apr 26, 2024
pdurbin added a commit to pdurbin/dataverse that referenced this issue Apr 26, 2024
@pdurbin
stub out Contributor Guide IQSS#10531
6b5ed03
@pdurbin pdurbin mentioned this issue Apr 26, 2024
Merged
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 7, 2024
@pdurbin
Merge branch 'develop' into 10531-contrib IQSS#10531
51f158e
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 7, 2024
@pdurbin
remove intro page and put its content in index and code pages IQSS#10531
32be795 


This is a bit of an experiment discussed with @vaidap and
@DieuwertjeBloemen where we are trying to put more content on
the index page rather than a table of contents.

Because we have a subpage (code.md) we still need to put it in
a toctree (or it will be an orphan), so I hid it the best I could
within the flow of the text.
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 7, 2024
@pdurbin
replace content of CONTRIBUTING.md with link to new guide IQSS#10531
f76c710
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 11, 2024
@pdurbin
expand "contributing code", other tweaks IQSS#10531
36b4ed9
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 11, 2024
@pdurbin
add translations to contrib guide IQSS#10531
a5c42c1
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 11, 2024
@pdurbin
add support, talks, working groups IQSS#10531
be05cad
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 11, 2024
@pdurbin
add issue triage, other tweaks IQSS#10531
13c814d
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 12, 2024
@pdurbin
move documentation into own sub page of contrib guide IQSS#10531
0b7cb9f
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 13, 2024
@pdurbin
shorted to just "code" IQSS#10531
fb461c7
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 13, 2024
@pdurbin
link to new "writing docs" under contrib guide IQSS#10531
b080842
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 13, 2024
@pdurbin
move toc IQSS#10531
55ce252
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 13, 2024
@pdurbin
move images and cross references IQSS#10531
c243a9c
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 13, 2024
@pdurbin
move writing docs page from dev to contrib guide IQSS#10531
a970df2
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 13, 2024
@pdurbin
reorg into writing guidelines IQSS#10531
f287110
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 13, 2024
@pdurbin
add intro for writing docs IQSS#10531
15c0284
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 13, 2024
@pdurbin
rewrite "versions" content into "hosting own guides" IQSS#10531
d92cb68
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 13, 2024
@pdurbin
move PDF content down (less important) IQSS#10531
6b3d06c
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 13, 2024
@pdurbin
Merge branch 'develop' into 10531-contrib IQSS#10531
5b26d88
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 13, 2024
@pdurbin
add release note IQSS#10531
147866b
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 13, 2024
@pdurbin
tweaks IQSS#10531
5c5e9f7
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jun 14, 2024
@pdurbin
incorporate feedback from @philippconzett IQSS#10531
946d1dd 
Via https://groups.google.com/g/dataverse-community/c/ejJrJmH6ojI/m/NnLSTlaMDwAJ
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jul 1, 2024
@pdurbin
Merge branch 'develop' into 10531-contrib IQSS#10531
b2c451a 
Conflicts:
doc/sphinx-guides/source/developers/documentation.rst
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jul 1, 2024
@pdurbin
re-apply changes about sphinx and docker IQSS#10531
9bd0ccf 
These changes were in 853965e as part of PR IQSS#10565 but were lost during
resolution of a merge conflict.
pdurbin added a commit to pdurbin/dataverse that referenced this issue Jul 1, 2024
@pdurbin
remove TODO about how vs when IQSS#10531
7a64dea
@pdurbin pdurbin added this to the 6.3 milestone Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: Feature a feature request
Projects
None yet
Milestone
6.3
Development

Successfully merging a pull request may close this issue.

Add a Contributor Guide pdurbin/dataverse
1 participant
@pdurbin