erlang / erlang-org Goto Github PK

Not sure if this is the right place for this or not; when I try to download the Windows binary for Erlang from erlang.org, it's blocked by chrome because erlang.org is https and the download link is http. I can copy/paste the link and change it to https and it works, but probably those links should be updated.

https://www.erlang.org/doc/search

With the release of the new erlang.org (congrats, btw, it looks great 😍), some deep links got broken, including ones in the blog posts on the site itself. For example, try the link titled "EEP 48" here: https://www.erlang.org/blog/my-otp-24-highlights/#eep-48-documentation-chunks-for-edoc

The built-in algolia search does not index anchors. For example if you search for "lists:reverse" you will end up at the top of the "lists" man page, not at the reverse function.

I've contacted algolia support to figure out why this might be.

There are many existing links to erlang.org/doc from elsewhere, such as Elixir's doc site:

https://hexdocs.pm/elixir/Process.html#flag/2

the links look like:

https://erlang.org/doc/man/erlang.html#demonitor-2

They all timeout now. Maybe we should 301 redirect them to the correct link as:

https://www.erlang.org/doc/man/erlang.html#demonitor-2

While, I'm not sure what the long term plans for what's pulled in via erlang/otp in regards to document pages, one thing is certain, we're currently creating a buggy situation per #41.

Specifically, the html files in doc/docs (pulled in from erlang/otp and massaged via perl scripts) in conjunction with the new search page added in #41 hard codes layouts in a non-resusable fashion setting up a scenario where something in the template in the otp repo needs to be added, removed, or updated but not done in the search.html source.

Maybe the most pragmatic thing to do now is build the search.html page via index.html.src that ends up in the repo as an ignored artifact (i.e., copy into place as search.html and use a script to replace the contents), though that feels like tacking on tech. debt.

Maybe OTP team has plans to move away from that system to jekyll templates and thus this issue.

https://bugs.erlang.org/browse/ERL-125

When hovering a function names in the searchable docs (i.e. the docs at http://erlang.org/doc/search/), a pencil button shows up. Clicking on the pencil should bring to the GitHub page where the code for that doc is defined. Instead, an empty page is shown.

E.g. -> Modules -> Array -> fix/1

This works correctly in the docs without the search functionality.

The nginx conf should either redirect root to www or handle requests without vhost (nicer imho).

Speaking of links, one things that I have had on my todo list is to change any links that point to www.erlang.org to instead point to / if they are not to be redirected in _redirects. This would allow the broken link checker to check those links as well just to make sure that they remain.

Originally posted by @garazdawi in #61 (review)

Hi. Documentation downloads seem to not be available for 25.1 at https://erlang.org/download/. The latest version available is otp_doc_html_25.0.tar.gz. Could they be added?

Currently, the search widget on the sidebar is the stock widget provided out of the box via docsearch.js. Doing some quick research it seems the idea behind the search widget provided by docsearch.js is primarily to get a site up and going with minimal to zero js/ts hacking required.

That's a great way to bootstrap but it has some limitations. It doesn't appear easy or possible to extend the widget anymore with docsearch v3, though perhaps more research is required.

It may be that we need to "fork" the widget to add the functionality we'd like to see on erlang.org. Below are a few enhancements we'd like to see :

Preview

On agolia's site we can see a nice side preview of a document as can be seen below :

## More results

While it's great to get all the results possible in the widget, it may be a better UX to limit the results and provide a link to the new search page added in #41 . This is also a nice to have as after clicking such a link, someone could bookmark the search. An example of this can be seen on docsearch's own page (show below) :

After switching to the static site an issue some pointed out was the inability to search via url query parameters (i.e., https://erlang.org/?q=eh.

Did some quick research around agolia search and found this is possible using instantSearch, which I also observed people using in along side docsearch.

A good example of this would be gitlab's doc site or docsearch's own site, both of which are static sites.

Examples :

https://docs.gitlab.com/search/?q=eh

https://docsearch.algolia.com/search/?q=url

Some example code :

https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/content/frontend/search/index.js

https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/layouts/instantsearch-head.html

https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/layouts/instantsearch.html

As we can see, there's not much going on there. instantSearch and agoliasearch are doing all the work.

Documentation for instantSearch routing :

https://community.algolia.com/instantsearch.js/v2/guides/routing.html

We'd optimally just use /?q= so that bookmarks people had previously would continue to work.

hello!

https://www.erlang.org/blog/my-otp-25-highlights/#selectable-features-and-the-new-maybe_expr-feature
there are link on this page --

When starting an Erlang node the specific feature (or all) must be enabled otherwise the .beam file with the feature will not be allowed for loading.
erl -enable-feature maybe_expr
Or
erl -enable-feature all

For more details see the feature section in the Erlang Reference Manual.

but on that link - https://www.erlang.org/doc/reference_manual/feature.html -

Page Not Found
Looks like you've followed a broken link or entered a URL that doesn't exist on this site.
Back to our site
If this is your site, and you weren't expecting a 404 for this path, please visit Netlify's ["page not found" support guide](https://answers.netlify.com/t/support-guide-i-ve-deployed-my-site-but-i-still-see-page-not-found/125?utm_source=404page&utm_campaign=community_tracking) for troubleshooting tips.

This issue is a collection of searches that do not yield the results expected:

• https://www.erlang.org/doc/search?q=file
• #69

Hi, apologies if this is not the right way to reach out to the maintainers.

I'm the developer behind Plausible Analytics and I saw that you're looking to integrate it to erlang.org. We rely on Erlang ourselves and would like to support the community by providing a free account for this project.

If you're interested, please write to me [email protected]

Since algolia docsearch is proprietry is it very hard to for anyone but me to contribute/change anything.

I stumbled across typesense, which seems to do about the same thing but we can host+test it locally... definitely worth looking into.

This page: https://www.erlang.org/downloads/22 should include a link to download the windows 22.3 installer.

Soon you will not be able to access the website over https from most major browsers without having to add a security exception. This issue can be solved by switching to a lets encrypt cert or something else.

replication

1. go https://www.erlang.org/
2. click on 'Documentation' link at top, to https://www.erlang.org/docs
3. click 'Erlang/OTP Documentation' link at top, to https://www.erlang.org/doc/
4. click in the search box at the top
5. type 'unicode' and hit enter
6. result: a broken page from Erlang/OTP 24.1.4, at https://www.erlang.org/doc/search.html?v=27&q=unicode

Going to https://www.erlang.org/doc/man/zlib redirects to https://www.erlang.org/doc/apps/erts/zlib however notice "zlib" is not "selected" in the sidebar:

only when we click it in the sidebar it is:

and the difference is:

• https://www.erlang.org/doc/apps/erts/zlib
• https://www.erlang.org/doc/apps/erts/zlib.html

This makes a big difference in apps with lots of modules like stdlib:

• https://www.erlang.org/doc/apps/stdlib/gen_server
• https://www.erlang.org/doc/apps/stdlib/gen_server.html

In the latter case, ExDoc highlights the module name and importantly scrolls sidebar down to its position.

If possible, I believe a quick fix is to add .html extension to redirects. Otherwise, we can look into support it in ExDoc somehow.

The new site moved the news/blog RSS feeds to new URLs. The old URLs should redirect to new URLs so feed readers can automatically update to the new URLs.

I spent a good amount of time looking for it to no avail.
Finally i found them in the release section of the GitHub repository.
I think the links do download the links should be included with each release.

"Find even numbers" _examples/7-even-numbers.md have this declaration:

-spec even(In) -> even(Out)
  when In :: Out :: list(integer()).

Which compiles with error:

find_even.erl:5:19: type even(_) undefined
%    5| -spec even(In) -> even(Out)
%     |                   ^

find_even.erl:5:24: type variable 'Out' is only used once (is unbound)
%    5| -spec even(In) -> even(Out)
%     |                        ^

Hi,
I am releasing an Elixir app, which uses ported code from this project into Elixir,

https://github.com/erlang/erlang-org/blob/master/_scripts/src/

I would like to know which license is this released under, if Apache 2 or the Erlang Public License, to give the proper credits,
Thank you.

i want watch the video

When searching for a specific function, say, erlang:self via modal pop-up Ctrl+K the search results produced are actually relevant, but the search snippet shows quite misleading information, see the screenshot:

While first result actually points to https://www.erlang.org/doc/man/erlang.html#self-0, the snippet does not make it clear and rather looks like some random match over some random function's documentation.

I think more appropriate solution would be to display at least erlang:self() in the snippet or even better - the typespec of this function. Or something more similar to how it looks on this page https://www.erlang.org/doc/search?q=erlang%3Aself

Automatically add a TOC to each blog/eep/news post.

The TOC could float to the left/right of the post using https://getbootstrap.com/docs/5.0/components/scrollspy/

I think the example is not a good one because it requires some preliminary experience with Erlang to understand. That is to say, if I know enough Erlang to grasp it, I wouldn't care about it, it'd be just decoration. OTOH, when I come to erlang.org curious about the language, seeing this thing first, well... "OMGWTF??? 😰"

We have all the information available to create https://erlang.org/download/otp_versions_tree.html when generating erlang.org, so we might as well use that and put some bootstrap styling on it.

An idea I had was to also add a filter where you can search for things such as:

• "inets" and get all versions that contain inets changes
• "inets-1.2.3" and the version that contains that inets version
• "OTP-123" and get all versions that contain that ticket
• "GH-123" and get all versions that contain that issue