Coder Social home page Coder Social logo

Comments (4)

jcbhmr avatar jcbhmr commented on August 23, 2024

I'm generally pretty OK at writing docs, so I can do the grunt work.

from templates.

jcbhmr avatar jcbhmr commented on August 23, 2024

Some ideas for GitHub wiki actions are:

from templates.

jcbhmr avatar jcbhmr commented on August 23, 2024

You know, before I actually do this I should get a second opinion! Always get a second opinion 😉 That means you @eitsupi

Thoughts on the wiki dev docs idea as a whole? Good idea, bad idea? Alternative better idea? Hold off? Put it all in a big CONTRIBUTING.md file?

from templates.

eitsupi avatar eitsupi commented on August 23, 2024

Thanks for listening to my input.

Actually, I am not too keen on using the wiki for that use.

  • I find it difficult to discuss what to edit because there is no Pull Request and review mechanism.
  • Markdown files in the main repository should be sufficient.

Also, since what we are dealing with here is a "Development Container," it is highly likely that the user is a developer, and I don't see much point in making a distinction between the two.

Thoughts on the wiki dev docs idea as a whole? Good idea, bad idea? Alternative better idea? Hold off? Put it all in a big CONTRIBUTING.md file?

We can also have a repository dedicated to documents and aggregate documents there.
Since this organization is likely to have multiple repositories with similar structures, it seems more suitable to consolidate documents into a single repository.


Deploying files from the main repository to the wiki is easy, and I see little need to use dedicated actions.
I set like bellow in the other repo.
https://github.com/rocker-org/rocker-versioned2/blob/d9dcc2caee7415b97cc14e39239da451798e25cd/.github/workflows/reports.yml#L102-L107

from templates.

Related Issues (12)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.