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

Move Contributors page to new directory for support in docusausrus #115

Closed
rishabkumar7 opened this issue Jan 21, 2023 · 7 comments
Closed
Assignees
Labels
enhancement New feature or request

Comments

@rishabkumar7
Copy link
Collaborator

Have to move contributors.md to new directory pages for support in docusaurus.
Also have to update the GH Action since Contributors.md gets automatically generated everyday

@rishabkumar7 rishabkumar7 added the enhancement New feature or request label Jan 21, 2023
@rishabkumar7 rishabkumar7 self-assigned this Jan 21, 2023
@rishabkumar7
Copy link
Collaborator Author

The action we currently have, that generates the Contributors.md, doen't provide valid md to be rendered by docusaurus.
Getting this error:

SyntaxError: E:\GitHub\learn-to-cloud\src\pages\Contributors.md: JSX value should be either an expression or a quoted JSX text. (13:21)
  11 |     <td align="center" style="word-wrap: break-word; width: 150.0; height: 150.0">
  12 |         <a href="https://github.com/madebygps">
> 13 |             <img src=https://avatars.githubusercontent.com/u/6733686?v=4 width="100;"  style="border-radius:50%;align-items:center;justify-content:center;overflow:hidden;padding-top:10px" alt=Gwyneth Peña-Siguenza/>
     |                      ^
  14 |             <br />
  15 |             <sub style="font-size:14px"><b>Gwyneth Peña-Siguenza</b></sub>
  16 |         </a>

@rishabkumar7
Copy link
Collaborator Author

Looking into this - https://github.com/marketplace/actions/contribute-list

@madebygps
Copy link
Collaborator

I think this can be closed?

@rishabkumar7
Copy link
Collaborator Author

Contributors.md is not being generated, will take a look at the action

@rishabkumar7
Copy link
Collaborator Author

Using both the new and the old action causes the docusaurus render to fail, since new action needs a comment in the Contributors.md file to add automated contributors, these comment don't render:

SyntaxError: /Users/rishabkumar/GitHub/learn-to-cloud/src/pages/Contributors.md: Unexpected token (206:1)
  204 |     </td></tr>
  205 | </table>
> 206 | <!-- readme: contributors -end -->
      |  ^
  207 |     </MDXLayout>
  208 |   )
  209 | };

@rishabkumar7
Copy link
Collaborator Author

I am going to move Contributors.md back to root while we figure this out as it is causing the staging preview to fail

@rishabkumar7
Copy link
Collaborator Author

Added another job to the contributor action to generate and SVG, which now renders in the docusaurus page 😅
The SVG is created by the action and can be found here static/img/CONTRIBUTORS.svg

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

2 participants