Giter Site home page Giter Site logo

Comments (9)

samtstern avatar samtstern commented on July 2, 2024 1

Even better: the codelab formatting guide should be a codelab! This is what Ubuntu does:
https://tutorials.ubuntu.com/tutorial/tutorial-guidelines#0

Bonus points if the source for the codelab is in markdown, which makes it something you can copy-paste from and self-proving.

from tools.

x1ddos avatar x1ddos commented on July 2, 2024

@djschny do you mean examples on a web page, translated from a markdown file or this gihub repo wiki?
Otherwise, the doc you linked to does provide some examples.

from tools.

x1ddos avatar x1ddos commented on July 2, 2024

Actually, maybe it's about time we translate that doc into a wiki page in this repo.
@marcacohen wdyt?

from tools.

djschny avatar djschny commented on July 2, 2024

@djschny do you mean examples on a web page, translated from a markdown file or this gihub repo wiki?

I'm referring to the linked Codelab Formatting Guide google doc.

Otherwise, the doc you linked to does provide some examples.

Sadly upon further inspection, when reviewing the doc to produce some labs, I completely missed the For example: prior to the actual example in each doc. My mind transposed the example and screenshot together.

My sincere apologies for not noticing. Feel free to close the issue, unless you want to leave it open for the last comment about translating to a wiki page in this repo.

Thanks for taking the time to look at this and sorry about the noise.

from tools.

mco-gh avatar mco-gh commented on July 2, 2024

It'd be nice to have a wiki page. The advantage of doing that is we won't have a separate doc on which to manage sharing. And it'll be easier for people to access. I'll do it.

from tools.

x1ddos avatar x1ddos commented on July 2, 2024

Awesome. Thanks @marcacohen!

from tools.

x1ddos avatar x1ddos commented on July 2, 2024

Hey Marc, any progress here? I'm thinking maybe instead of a wiki page, we might want just a markdown file so that people can propose changes and improvements via pull requests.

from tools.

mco-gh avatar mco-gh commented on July 2, 2024

I agree, md is better than wiki for this purpose. Leave this assigned me for now (have a few higher prio items atm but I'll get to it if no one else wants to take it off my hands).

from tools.

helmutgranda avatar helmutgranda commented on July 2, 2024

Would it have to be a 1:1 with the following document?

https://docs.google.com/document/d/18dnMdUJQaGKY1Tit_-fO1YOpOpAbA4hh0YDXQlCEjvA

If that is the case the conversion should be rather quickly.

from tools.

Related Issues (20)

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.