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.

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

update collaboration/contribution guideline towards markdown #114

Open
orangecms opened this issue Aug 16, 2020 · 5 comments
Open

update collaboration/contribution guideline towards markdown #114

orangecms opened this issue Aug 16, 2020 · 5 comments

Comments

@orangecms
Copy link
Collaborator

We have an older section that encourages ReST, though we wanted to use markdown; only document headlines (the first one on top) really need to be written in ReST now as far as I understand the Sphinx docs. I'm not sure about remarks (| Warning: Be sure to read this carefully |).

The file in question is collaborate/Readme.md.

@orangecms
Copy link
Collaborator Author

Addendum:

It seems like remarks are actually just empty tables with only a headline; hence the line after it | --- |.

I.e.,

| Remarkable headline |
| --- |

looks like a "hint"; and here on GitHub:

Remarkable headline

@pizofreude
Copy link

From what I understand about this issue are:

  1. An update for the collaborate/Readme.md file to serve as guideline for any user to start collaborating or contributing in the Pocket Science Lab Project
  2. The guideline must be written to guide collaborators using Markdown instead of ReST format for their project description and tutorials.
  3. Provide open-source alternative tool that tailored towards Markdown instead of using notex or any other ReST editor.
  4. Explain Best-Practices workflow for all user to refer when contributing.
  5. Only document headlines (the first one on top) really need to be written in ReST
  6. For remarks: place empty tables with only headline in this Readme.md as follows:
    | Remarkable headline |
    | --- |

Am I understanding the issue correctly? I would love to contribute and become member of the FOSSASIA community. Feel free to assign me this task. Thanks.

@Satarupa22-SD
Copy link
Contributor

@orangecms could you please assign this issue to me. Thanks!

@orangecms
Copy link
Collaborator Author

There is no assignment, just file pull requests.

@Satarupa22-SD Satarupa22-SD mentioned this issue Sep 6, 2024
6 tasks
@Satarupa22-SD
Copy link
Contributor

@orangecms I have created a PR(#132) on the same, please look into it. I am open to any feedback or changes as needed. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants