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

Wiki Formatting? #924

Closed
jpartain89 opened this issue Aug 23, 2017 · 10 comments
Closed

Wiki Formatting? #924

jpartain89 opened this issue Aug 23, 2017 · 10 comments
Assignees
Labels
documentation Documentation issue

Comments

@jpartain89
Copy link

What language are the wiki pages supposed to be coded in....

Because there's a ton of // items and ; at the beginning of lines....

These don't exactly make sense, especially if you're trying to use MarkDown, as other parts of the docs ARE appropriately using...

If there is a need to change the Wiki pages/Documentation to a specific language, I'd be more than happy to help, but in need of a singular language/format.

@cigamit
Copy link
Member

cigamit commented Aug 23, 2017

Thanks. We are currently reviewing the whole Wiki/Documentation effort.

@cigamit
Copy link
Member

cigamit commented Aug 23, 2017

Can you post a few links of those pages?

@cigamit cigamit added the documentation Documentation issue label Aug 23, 2017
@devsibwarra
Copy link
Contributor

@cigamit https://github.com/Cacti/cacti/wiki/Linux-Installation is one example. Looks like a spliced mix of MediaWiki and MarkDown was used on that page

@cigamit
Copy link
Member

cigamit commented Aug 28, 2017

Okay, noted. Right now we are working on a refresh to the documentation plan. We have created a documentation repository, and we will be breaking the rather large manual.md into categories that can be displayed in the various GUI sections of Cacti.

For example, we will have a documentation section on Presets, Presets > VDEF, Presets > Colors, Presets > GPrint Presets, Presets > Data Source Profiles, etc.

If you have suggestions for Chapters, we would welcome them. Pull requests there are also welcomed. My first thought would to be to align the markdown files similar to how our HTML documentation reads, but to add these various sections so that we can link to them inside the GUI.

@jpobeda
Copy link
Contributor

jpobeda commented Aug 28, 2017

Whatever you decide, please do it thinking on multi language so people can help with translations in the future.

@cigamit
Copy link
Member

cigamit commented Aug 29, 2017

Tony would like help first updating the documentation in English, then we will create independent language directories such as 'en', etc. He please use the Wiki on the documentation repo to share thoughts on chapters. Then, if you can help with English first, we will then move to other languages.

Pull requests will be the way we take updates as with everything else.

@jpobeda
Copy link
Contributor

jpobeda commented Aug 30, 2017

I'm happy to help.

@ronytomen
Copy link
Member

Good to know!

I'm going to move this issue to the documentation repository.

@ronytomen ronytomen self-assigned this Sep 11, 2017
@ronytomen
Copy link
Member

Ok, I can't move issues.. lol

It will stay here to remind me.

@netniV
Copy link
Member

netniV commented Jul 20, 2018

We can't move this issue, but I have recreated it as Cacti/documentation#4

@netniV netniV closed this as completed Jul 20, 2018
@Cacti Cacti locked and limited conversation to collaborators Jul 20, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation issue
Projects
None yet
Development

No branches or pull requests

6 participants