https://docs.chocolatey.org - new docs website
License: Apache License 2.0
See https://github.com/chocolatey/choco for further development
Apache 2.0 - see docs/legal (just LEGAL in the zip folder)
##Please see the wiki
See docs/legal/CREDITS (just LEGAL/Credits in the zip folder)
Currently, the left navigation doesn't provide anyway to collapse/expand the nav items without navigating to the actual page. It would be nice to be able to click the carrot icons to expand/collapse the items to see whats inside first.
Using xref:extensions without setting it in the front matter, results in this error:
The file being referenced is located at input/en-us/features/extensions.md
After adding it in the front matter, it worked as expected.
As a test, I went the home page and changed a link to use xref:faqs, which seemed to work, but changing a link to use xref:why results in the same error above in the picture.
Not sure what it's not liking, it seems to be random on whether it's going to like the xref or not, but the results are always consistent (it either works every time, or says it can't be found every time).
https://github.com/chocolatey/choco/wiki/How-To-Parse-PackageParameters-Argument uses colons for its sample. It should allow equals as well.
@DarwinJS mentions this makes things look inconsistent for how you pass arguments as compared to install arguments, which are typically passed with "=" in between property value pairs.
For example on this page:
https://chocolatey.github.io/docs/en-us/central-management/overview
This is due to the fact that the images are expected to be here:
https://chocolatey.github.io/assets/images/features/ccm/central-management.png
When in fact they are here:
https://chocolatey.github.io/docs/assets/images/features/ccm/central-management.png
NOTE: The docs in the URL.
This will be fixed as a result #5 unless we want to add another solution in the interim.
UPDATE: As Chocolatey Gitter chat is now unavailable, I've added a screenshot of the Gitter chat.
This is a follow up on Google Groups thread on ambiguity of binary producing projects vs software project and alike and how to fit all this into Nuspec tags with appropriate aliases.
For example, should projectUrl point to original software source project or an unofficial 3-rd party binary producing project URL that we are packaging with Chocolatey?
We have a lot of great reference docs, which is good if you know exactly what you are looking for, but it would be good to also have more concept and narrative types of docs that are great for learning.
The below will become the docs home when complete. There are lots of needs for documentation and walkthroughs here though.
Read-Host and Prompt have timeouts Chocolatey's PowerShell)What do I need to know upfront?
Guidelines
Submitting Documentation
PowerShell
C#
Other
Versioning strategies for Chocolatey for less than v1 (SemVer compliance)
After a discussion in the Gitter channel around there being no list of tags I'm raising this issue for discussion around this before creating the docuimentation.
It's been suggested that the documentation be created on the Creating Packages page.
The list of tags I'm aware (off the top of my head):
List of tags I'd like to add:
* licensed - package requires a license to use - this is different from trial which still runs for a period of time; license tag is already recommended.
Also highlight that packages should not include the tag 'chocolatey'
The tags so far agreed on are:
Package category tags still under discussion:
Other tags still under discussion:
I looked at the Wiki FAQ section titled **What is the difference between packages named .install (i. e. autohotkey.install), .portable (i. e. autohotkey.portable) and * (i. e. autohotkey)? (link) and I found it inadequate. It doesn't answer the following question:
If there are packages named *.install, *.portable and *, what happens when I do choco install * as opposed to choco install *.install or choco install *.portable?
Also, the link at the end of the section appears broken.
Currently, items like :floppy_disk: and :heavy_plus_sign: are not rendering correctly when generated through Statiq.
There should be a way within Statiq to render these emojis correctly.
Of course with the redirect from.
Currently, the navigation sidebar is only showing two levels of navigation. In the Wyam version of the site, it would expand indefinitely to show all pages. Do we want something similar?
Related to this, with the change in #1 the top level navigation is now rooted to the wrong location, and is including the index.md at the root of the project. We need to change this to use the index.md in the en-us as the root page.
Ensure these languages are included in the prism.js
Currently xml is known to be missing. See the first code block in this section: https://docs.chocolatey.org/en-us/central-management/setup-service#faq
Things Gulp can help with:
Surely there are more, but overall I feel like this would be a great addition to add to the build process.
In the head of _layout.cshtml there are these meta tags:
<meta property="og:title" content="@title" />
<meta property="product:brand" content="Chocolatey" />
<meta property="og:description" content="Chocolatey is software management automation for Windows that wraps installers, executables, zips, and scripts into compiled packages. Chocolatey integrates w/SCCM, Puppet, Chef, etc. Chocolatey is trusted by businesses to manage software deployments." />
<meta name="description" content="Chocolatey is software management automation for Windows that wraps installers, executables, zips, and scripts into compiled packages. Chocolatey integrates w/SCCM, Puppet, Chef, etc. Chocolatey is trusted by businesses to manage software deployments." />
<meta name="flattr:id" content="mqgjkp">
<meta property="DC.title" content="@title" />
<meta property="og:site_name" content="Chocolatey" />
<meta property="og:type" content="product" />
<meta property="product:category" content="software" />
<meta property="og:image" content="https://chocolatey.org/content/images/icon_slogan.png" />
<meta property="og:url" content="@Context.GetLink().TrimEnd('/')@Document.GetLink()" />
<meta property="copyright" content="Chocolatey is Copyright 2020 - @DateTime.UtcNow.Year Chocolatey Software,Inc." />
These tags were copied from chocoaltey.org. They need to be analyzed to determine if they are still relevant or if they are outdated (may be a better way of doing it now). There are also other tags that could be added. For example, Twitter has its own set of tags that would optimize the sharing experience when our website is tweeted about. See https://developer.twitter.com/en/docs/twitter-for-websites/cards/guides/getting-started
With the move to statiq, it would be a great time to access our current docs navigation structure and move items to places that make more sense.
In the Wyam version of the site, we were using this:
To provide easily copying code from a code block into the clipboard.
If there is something that we can use for free, let's use that for now. We can look at other options later.
Links should be added to the navigation somewhere, and possibly in the footer, that lead back to chocolatey.org and to the community.
For example here:
This should contain a list of all the pages that this section contains.
For the life of me, I cannot figure out how to make a standalone/portable/whatever Chocolatey package. There are 4 executables I'd like to package into Chocolatey package; no MSI, no installers, no unnecessary complexity. What is the directory layout supposed to be? https://github.com/chocolatey/choco/wiki/CreatePackagesQuickStart offers no assistance.
To be clear, I don't want to bundle an installation script. I just need 4 files extracted to somewhere in %ChocolateyInstall%\lib\PackageName and symlinked from %ChocolateyInstall%\bin.
An explicit file layout for the archive, like:
/
/Foo.nuspec
/tools/
/tools/release/
/tools/release/bin/
/tools/release/bin/foo.exe
would go a long way.
It would be good idea to have an announcement banner built in so that we can display important announcements at the top of the page, much like on chocoltey.org. This banner should be easily removable if there are no announcements.
Right now, all child pages are shown in the "Child Pages" grid on index pages, even if they are hidden in the navigation. If a page is hidden in the navigation, it should also be hidden in this grid.
Think about it like this, https://chocolatey.org/docs/ is going to do a redirect to https://docs.chocolatey.org/en-us/, so you can use that to build the redirect from.
In the Wyam version of the site, it was using the following JavaScript library:
https://github.com/bryanbraun/anchorjs
To provide clickable links for all headings on a page. This currently isn't implemented in the Statiq version of the site.
This stemmed from a discussion on Google Groups.
The processes now followed are different to those documented and we need to update them.
If a header contains a link, the right sidebar links are generated with a "link inside of a link". There needs to be a way to accommodate this edge case.
This can be seen on: https://docs.chocolatey.org/en-us/chocolatey-gui/release-notes
Implement the changes with cloudflare to support this and then change it here as well.
When installing a package, an error might occur during the first installation. The second time you try to install, you will get a successful message, which can be misleading. Removing the folder for the package in C:\ProgramData\chocolatey\lib will give a fresh install the next time.
Is this mentioned somewhere in the documentation?
@ferventcoder Can you confirm what license should be used for this repository?
In the Wyam version of the site, we had the button to click to open the Chocolatey Gitter room, do we want this in this version as well?
I know we're not supposed to ask questions here, but I thought this was a more fitting place since I'm not just looking for answers, but I think the answers need to be in the wiki or even in Chocolately itself, so others can find them. I've searched high and low and haven't found any information (or, for the first question, any that made sense) on these things.
Ferventcoder asked for an issue to be created in regards to my question so the FAQ could be updated. Below was his answer to me.
At this time choco doesn't detect what is previously installed. You can however just install packages usually right on top of existing applications (and it will upgrade them if they are needing upgrades). If you run into any issues you can uninstall and then use choco to install.
Currently, most links within the site use navigation links similar to the following:
[[Frequently Asked Questions|ChocolateyFAQs]]
These need to be changed to normal, relative, markdown links.
NOTE: This will be dependent on implementing this #7 as some links go directly to headers within a page.
It would be nice to add a breadcrumb trail under the title on each page heading for easier navigation. Something like seen here: https://getbootstrap.com/docs/4.5/components/breadcrumb/
Ensure that you specify how it can be added manually.
And that execution policy restricted won't allow it to be loaded at all:
UPDATE: As Chocolatey Gitter chat is now unavailable, I've added a screenshot of the Gitter chat.
Is this something that we want here?
It would be a good idea to convert all links to xref links so that if in the future, we want to move files around, we will not have to go back and redo all the relative links to point to the new path.
See documentation on this feature at:
https://statiq.dev/web/content-and-data/content/links-and-cross-references
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.