Giter VIP home page Giter VIP logo

atom.io's Introduction

Atom and all repositories under Atom will be archived on December 15, 2022. Learn more in our official announcement

Atom.io Site Feedback

The repository is for feedback on the Atom.io website and the package API used by apm. Have something to suggest or a bug to report? Take a look at the issues on this repo and see if there's already a discussion going, otherwise file a new issue and get the conversation started.

atom.io screenshot

For issues with the documentation from the Atom Flight Manual, see atom/flight-manual.atom.io.

atom.io's People

Contributors

darangi avatar forivall avatar mnquintana avatar platy11 avatar simurai avatar thedaniel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

atom.io's Issues

Summarize methods in left bar, remove collapsing/expanding

From @ssorallen on August 6, 2015 22:45

This is a suggestion based on Ruby's documentation site (like http://ruby-doc.org/core-2.2.0/Array.html for example).

Currently each class documentation page for Atom (like https://atom.io/docs/api/v1.0.5/TextEditor for example) attempts to be both a table of contents and the content itself by collapsing all sections by default. This makes searching for content difficult with Cmd/Ctrl + f. If the table of contents, the list of properties and methods, instead lived in the left bar then the main content area would not need to behave like a table of contents as well and could avoid collapsing content at all.

Copied from original issue: atom/apm#414

Add information on spec helpers to "writing specs"

The "writing specs" page should at the very least, link to the spec-helper file in atom so that package/PR authors can see what helpers are available when writing specs.

So far, it looks like the list is

  • jasmine-jquery - already well documented, a link is good enough.
  • toBeInstanceOf
  • toHaveLength
  • toExistOnDisk
  • toHaveFocus
  • toShow - Tests if the element is visible in the dom.

Originally discussed on slack, when I was trying to find this information.

edit: I'll be submitting a PR on docs

Use consistent naming and references to macOS

Since a picture says more than a thousand words, or some such...
atom

We should reference the OS/platform as OS X, not OSX or Mac. Mac is the hardware platform that runs the OS, not the OS itself. And OSX is simply a misspelling of the name.

Improve visibility of RSS feed?

Hi there

I raised an issue on the atom discussion boards about the lack of an RSS feed for package releases and updates. Somebody kindly pointed out that there is one, but they had to search for it to find it.

Maybe a link to it could be added to the "Keep in Touch" section at the bottom of the page?

Now I've found the RSS feed, my original issue isn't quite so important - I was wondering about displaying dates/times on the packages page. It might still be quite useful though.

Cheers,
Nige

Cannot register package.

From @jonasws on July 5, 2015 22:8

I have been trying for a while to publish my package github-utils, but I keep getting the following error when I try to run apm publish minor

Registering package in jonasws/github-utils repository failed: 
That repo does not exist, isn't an atom package, or you do not have access

I do indeed have access to the repo. I have tried to do apm login. Is something at fault with my Atom.io account user? Any comments would be greatly appreciated!

Copied from original issue: atom/apm#393

Link primitives to MDN's primitives doc

From @ssorallen on August 11, 2015 0:36

This is related to atom/atom#8124

Lowercase JavaScript primitives should link to https://developer.mozilla.org/en-US/docs/Glossary/Primitive.

Atom's documentation mostly refers to the uppercase wrapper objects like Boolean, Number, and String, but nearly all of those uses should reference the lowercase primitives boolean, number, and string instead. atom.io links {Boolean}, etc. to the wrapper objects, but it's unclear if it correctly links primitives like {boolean} to a doc describing primitives like https://developer.mozilla.org/en-US/docs/Glossary/Primitive.

Copied from original issue: atom/apm#415

Add about the team page to atom.io

From @mark-hahn on January 22, 2015 20:54

I would like to see an "about us" page on atom.io. It should have a photo and short bio for every core team member along with primary responsibilities. Many consider these public relations junk but I for one would like to see faces on the people that have such a big impact on Atom. I think this would put a human face on the project and make it more welcoming.

Also a brief history of Atom, motivation for creating Atom, and a vision for the future would be nice.

Normally on an open-source project it would be hard to pick out contributors to be considered "core" but here it would be any github employee assigned to Atom.

Copied from original issue: atom/atom#5223

[Suggestion] Make changelogs mandatory for packages

It's an annoying and confusing experience to only encounter a changelog on some apps and see it missing on others, I would love to see having this as a requirement to being able to host packages on atom.io.

In-page links don't work because their target anchors don't have the expected id attribute

There are README.md files of packages like this one that point to parts of the same page that work just fine in github but not in atom.io because the target of those anchors don't have the expected id attribute.

for example:

works: https://github.com/suda/tool-bar#plugins
doesn't work: https://atom.io/packages/tool-bar#plugins

what was expected: expected to go to the plugins section
what happened: end it up in the top of the page

Please make links for v0.186.0 or previous documentation redirect to https://atom.io/docs/latest

We are receiving reports of numerous people referring to old documentation because when they click "go to latest" from really old links, it takes them to v0.186.0, i.e. pre-atom/docs documentation. It would be better if things like https://atom.io/docs/v0.186.0/your-first-package was redirected to https://atom.io/docs/latest and have to find the "your first package" stuff than to be stuck looking at outdated and ever-increasingly incorrect documentation.

Cannot unpublish package once GitHub repository deleted

From @Sheng-Bo on July 7, 2015 15:16

This is the package I want to remove from Atom package repository:
https://atom.io/packages/chinese-menu

Would you please remove it for me manually? Because I am afraid that this broken package could cause confusion for Atom users.

My suggestions:

  1. Is it possible to have a "delete package" button on my Atom user profile page?
  2. Is it possible to use APM to log into GitHub before unpublish my package?

Thanks so much.

Reference: https://discuss.atom.io/t/cannot-unpublish-package-once-github-repository-deleted/18580

Copied from original issue: atom/apm#394

apm publish gives Application Error

From @noseglid on May 12, 2015 19:34

Not sure if this is where this issue should go. Please direct me to the correct forum otherwise.

I get this:

$ apm publish -t v0.32.0
Publishing [email protected] โœ—
Creating new version failed: Application error

I've debugged a little, and it appears I get 500 Internal Server Error from the API. So likely something is off with whatever apm communicates with.

Copied from original issue: atom/apm#364

Display type info in method signatures

From @ssorallen on August 6, 2015 22:37

Surfacing type information in method signatures would make scanning the docs more valuable. For example from the TextEditor (https://atom.io/docs/api/v1.0.5/TextBuffer#section-Mutating%20Text):

Currently:

::setTextInRange(range, text, [options])

::insert(position, text, [options])

Surfacing type information in the signature:

::setTextInRange(range: Range, text: string, options?: Object): Range

::insert(position: Point, text: string, options?: Object): Range

The examples are formatted to fit Flow's type annotations.

Copied from original issue: atom/apm#413

[Website] "Other platforms" link still redirects to FAQ on atom.io

From @mnquintana on January 21, 2015 15:16

Now that Atom is available for all platforms, I think it would be better UX to instead actually show the releases for the other platforms when you click "Other platforms" from the home page. Right now, it just redirects to the FAQ question, which just states that builds are available for all of these platforms, but doesn't actually direct you to download them (instead it seems to suggest that you have to compile it yourself if you want to use it).

Copied from original issue: atom/apm#266

Add view for showing a single Release and its full list of changes

Currently, https://atom.io/releases shows the full list of changes (e.g. all merged PRs) for each minor release, including the Notable Changes, which can be quite overwhelming. Here's what I'm thinking:

  1. Only show Notable Changes in the index view at https://atom.io/releases
  2. Add a new view for showing a single release (e.g. https://atom.io/releases/v1.3.0). This view would show the full list of changes (e.g. all merged PRs) for that release.
  3. Change GitHub release links in index view to point to the new view at https://atom.io/releases/[version]
  4. Add a link to view the release on GitHub to the new view at https://atom.io/releases/[version]

This way, https://atom.io/releases would be a summary of notable changes, and users would click on a particular release to get more detail about the changes.

What do you think?

404 - Broken link to chapter 3 from Atom Packages page

Was browsing around and noticed that the following link was 404ing. Looks like the address was changed however the link was never updated.

The link is from Flight Manual -> 2: Using Atom -> Atom Packages (highlighted below)

image

Broken links in FAQ, info on contributing to Atom difficult to find.

From @sumyungguy on December 3, 2015 15:37

I'm a new user having trouble with some broken community packages. I was looking for general information on how packages are published to atom.io, who is responsible for them, and how I could perhaps contribute to fixing them, particularly when the original author is no longer active or responding to pull requests and so on. Eventually I tracked down the info, but I found it difficult to locate.

In the FAQ at https://atom.io/faq the two links under "How can I contribute to Atom?" are broken:

1 - "creating a package" - https://atom.io/docs/latest/creating-a-package
The content formerly at this URL has been mostly merged into "package: word count":
https://atom.io/docs/latest/hacking-atom-package-word-count
...and that seems to be the most appropriate place for the FAQ link to go to.

The "package: word count" title is somewhat unintuitive compared to the former "creating a package", and despite spending some time looking through the site, I only found the info about publishing by putting the broken link from the FAQ into the Wayback Machine at archive.org. There's not much to indicate that this single page contains the majority of the reference info about writing, debugging, and publishing packages.

I see in the planning outline that there's a whole chapter on contributing being considered, but in the meantime a little cleanup might be helpful. I'd like to suggest having a more descriptive name for the "package: word count" page, a better explanation of the contents in the opening paragraph, and maybe either a mini table of contents at the top of the page, or breaking out some of the sections separately so they can appear in the main table of contents, eg. creating, testing and debugging, and publishing. You might also consider renaming section 3.7 from "debugging" to "troubleshooting", since actual debugging is covered in the packages page.

The info about publishing could perhaps be moved or at least linked to the "Maintaining Your Packages" section in chapter 4, which is the first place I looked, but only found info on unpublishing...

2 - "contributing guide" - https://atom.io/docs/latest/contributing
This content is in the atom master at https://github.com/atom/atom/blob/master/CONTRIBUTING.md and contains all kinds of very useful information... but I couldn't find it anywhere in the docs site, and again only located it by putting the broken FAQ link into the Wayback Machine.

Copied from original issue: atom/flight-manual.atom.io#146

Improving Atom's release notes / changelogs

From @mnquintana on August 5, 2015 22:17

Challenge

Being a very modular project, Atom has a lot of changes happening across a lot of repos. This can make it quite a challenge to keep track of all the changes being made in Atom from version to version. Unfortunately, that has sort of meant that our release notes end up being rather bare-bones summaries of what's changed in any particular version, rather than complete, well, changelogs. In addition, none of our bundled packages or libraries have any release notes at all right now - it's only Atom core.

I think it's important to publicly document every significant change we make to Atom across all of our repos, which should make it a lot easier for users to know what to expect from each release, and hopefully help prevent surprises like atom/toggle-quotes@8899f00#commitcomment-12552713 or atom/atom#8226.

Proposal

  1. Add CHANGELOG.md files to each package and library repo (or leverage GitHub Releases)
    • I'm personally ๐Ÿ‘ for CHANGELOG.md files - they're version-controlled, simple to update, easy to discover, and will be displayed properly in settings-view.
  2. Add a CHANGELOG.md to atom/atom to be used exclusively for core changes
  3. Update them individually with each significant changes as they are made
  4. Concatenate and organize all changelogs for atom.io/releases
    • For UI here it might be nice to take some inspiration from Firefox release notes - default to the short summary display, and offer a "view full list of changes" option for those who really want to dig deeper.
    • Maybe even add the ability to filter by package / library?
  5. atom/atom release notes (ie. the notes used in GitHub Releases, rather than the CHANGELOG.md) can continue to work as the short summary of what changed.

/cc @atom/feedback

Copied from original issue: atom/atom#8240

Apm get a application error

Creating new version failed: Application error
I can't publish my package~
This bug again? I hope I can fix it

Intermittent service unavailable errors

Had to start the build process three times before it made it all the way through this morning:

[master][~/Source/atom] script/build
Node: v1.8.1
npm: v2.13.3
Installing build modules...
Installing apm...
Installing modules โœ“
Installing [email protected] โœ—
Unable to download https://www.atom.io/api/packages/atom-dark-ui/versions/0.50.0/tarball: 503
[master][~/Source/atom][1] script/build
Node: v1.8.1
npm: v2.13.3
Installing build modules...
Installing apm...
Installing modules โœ“
Installing [email protected] โœ“
Installing [email protected] โœ“
Installing [email protected] โœ“
Installing [email protected] โœ—
Request for package information failed: atom.io is temporarily unavailable, please try again later.
[master][~/Source/atom][1] script/build
Node: v1.8.1
npm: v2.13.3
Installing build modules...
Installing apm...
Installing modules โœ“
Installing [email protected] โœ“
Installing [email protected] โœ“
Installing [email protected] โœ“
Installing [email protected] โœ“
Installing [email protected] โœ“
Deduping modules โœ“
Running "download-atom-shell" task

Running "download-atom-shell-chromedriver" task

Running "build" task

Running "coffee:glob_to_multiple" (coffee) task

Add way to document services provided by Atom default-installed packages

I feel like the services provided or consumed by the Atom default-installed packages (autocomplete-plus, status-bar, tree-view, tabs, etc) should be documented in a central location rather than only in the package README. This would make the most sense in the developer documentation, but there isn't a way to include this currently implemented.

Please add a capability to document Atom provided or consumed services in the developer documentation.

Unable to register package

I'm having no success in trying to publish my package.

apm login works, but every apm publish minor keeps returning:
image

I got prompted for my Github credentials once, which I provided an access token for (I'm using 2FA), but it never seems to work.

Running git from my command line works fine when managing my other github repos.

I'm happy to completely wipe my atom account clean and try again.

Entire details of the problem are described in the atom discussion forum:
https://discuss.atom.io/t/publishing-packages-doesnt-prompt-for-github-credentials-fails/19490

"atom.io is temporarily unavailable"

Trying to install a package, getting this error:

Request for package information failed: atom.io is temporarily unavailable, please try again later.

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.