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

Add documentation about logging #1520

Open
pascalberger opened this issue Jan 31, 2021 · 19 comments
Open

Add documentation about logging #1520

pascalberger opened this issue Jan 31, 2021 · 19 comments

Comments

@pascalberger
Copy link
Member

We should add a page explaining how logging works in Cake.

@KishkinJ10
Copy link

@pascalberger I am a beginner can I work on this ?? What resources should I refer for adding the docs about logging?

@nils-a
Copy link
Member

nils-a commented Aug 10, 2021

@KishkinJ10 everyone is welcome to help!

I would suggest to start with referencing/documenting the built-in logging aliases and adding some examples for using those.
I think having examples twice, one for Cake script and one for Cake frosting would also make sense.

Something like an advanced section could contain a hint that Cake ships with Spectre.Console and show some (real simple) examples of integrating that.

@pascalberger
Copy link
Member Author

We already have the Console Output page containing a link to the logging aliases and mentioning of Spectre.Console. I think the points mentioned in this issue are already done, but we probably can improve this page with some documentation how the verbosity switch and logging aliases work together (e.g. which verbosity level shows which log messages), documentation how to retrieve log level through ICakeContext.Log and example how to use this in a script (e.g. pass verbosity to other tools, or run different code branches based on verbosity)

@Kevin-Usadadiya
Copy link

hey, can I work on this project

1 similar comment
@bilalshaikh292
Copy link

hey, can I work on this project

@devlead
Copy link
Member

devlead commented Aug 19, 2022

Feel free to send a PR and we'll review it.
Ask here or on PR if there're any questions.

@bilalshaikh292
Copy link

what is pr? is it proposal?

@bilalshaikh292
Copy link

I am a full stack developer and I have experiance in web devlopment in HTML,CSS,JS,WORDPRESS,BOOTSTRAP let me khow if I
can contribute

@devlead
Copy link
Member

devlead commented Aug 19, 2022

A pull request, a proposal of change of files in this repository.
Documentation on our site is written in markdown, all in the input folder here:
https://github.com/cake-build/website/tree/master/input

You can also find each page source by hitting the edit button on cakebuild.net
image

We are working on switching to a new engine (Statiq), all content will be brought over, but i.e. css/js might not - so assistance there might be worth holding of a bit.

@bilalshaikh292
Copy link

so can you assign me a task so that I can start working.

@devlead
Copy link
Member

devlead commented Aug 19, 2022

sure done

@bilalshaikh292
Copy link

so what that I have to do ?
I require a few help after that i will start working coz i am new to github.

@devlead
Copy link
Member

devlead commented Aug 19, 2022

  1. you'll need to fork
  2. do your changes in your fork
  3. create a pull request

Read more about forks and pull requests in GitHub docs at
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request

Read more about the website in the repository readme
https://github.com/cake-build/website/blob/master/README.md

Documentation is written in markdown, you can read more about that here
https://github.github.com/gfm/

@bilalshaikh292
Copy link

I have done the fork. now what is the task for me?

@bilalshaikh292
Copy link

is there any task like build a page or design css for a page or i have to work on isssues?

@bilalshaikh292
Copy link

@devlead pls reply.

@yashdev9274
Copy link

is this issue alive, can I work on this project along with my developer friend @kartikver15gr8 .

@whiletrueee
Copy link

@pascalberger is this issue still alive i would like to work on this

@cake-build cake-build deleted a comment from Marshmallows777 Sep 22, 2022
@Haricharan0310
Copy link

@pascalberger Hey! is this issue still alive? If it is, I would like to work on it.

@bilalshaikh292 bilalshaikh292 removed their assignment Jul 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

10 participants