doctrine / doctrine-website Goto Github PK

https://www.doctrine-project.org/projects/doctrine-mongodb-odm/en/1.2/reference/annotations-reference.html#title.1.47

vs

http://doctrine-orm.readthedocs.io/projects/doctrine-mongodb-odm/en/1.2.x/reference/annotations-reference.html#referencemany

Right now it is empty and says coming soon. Even something very basic to get started would be better than what we have now.

https://github.com/doctrine/collections/tree/master/docs/en

For security disclosures. Who to contact, etc.

• Consistent header
• Consistent links for help
• Link to the project on the website

https://www.doctrine-project.org/team/

It now contains 7 out of ~50 members, it looks a bit weird.
It should ideally show active/retired status and responsibilities/scope.

Design ideas:

• instead of having vertical list, make categorized columns - something like https://getbootstrap.com/docs/4.0/examples/album/
• don't publicly disclose e-mails - although it's an MD5 on the website, it's raw in source, I'd suggest using GitHub avatar instead or at least pre-hashed ID

Import can be done from https://api.github.com/orgs/doctrine/members (docs: https://developer.github.com/v3/orgs/#get-an-organization)

These links used to exist and are currently 404ing. It should just alias to the current stable version.

Each project should have a toc.rst that is used for the sidebar and the homepage of the docs.

The toc.rst should not use the glob option and instead explicitly define what shows up in the toc/sidebar and the order it should show up in.

The YAML mapping documentation got lost in the new (very pretty) website. This page lead to a 404 Not Found: https://www.doctrine-project.org/projects/doctrine-orm/en/stable/reference/yaml-mapping.html

You could do a simple server on something like Laravel Forge and Travis where if Travis returns all tests passing, it will trigger Forge to deploy to production.

Currently the code is copied and modified in https://github.com/doctrine/doctrine-website/tree/master/app/src/Gregwar/RST but we should host a fork and reference that in composer.json instead. Eventually our modifications should be submitted back upstream.

Enhance /projects/{project} page to have initial docs or readme on that page so you don't have to click to the full docs to find out more about the project.

https://github.com/doctrine/doctrine-website-sculpin/blob/master/app/config/sculpin_kernel.yml#L180

While a nice-to-have, being unable to build the website on windows might make contributions harder for some people (and yes, I tried contributed from my Windows computer rather than the Ubuntu one I'm using for development most of the time).

Until now I identified these issues:

• sculpin has a bug on windows, breaking the CLI initialization (fixed in dflydev/dflydev-embedded-composer#22)
• the build-website command fails when trying to run processes using globs with mv

Show more projects per column and try to include other info like latest version.

This way each project can provide the data for the website instead of it all being in the projects.yml in doctrine/doctrine-website. See conversation in #101 for context.

We need aliases like [email protected] and it would be nice if we all had doctrine branded e-mail addresses.

For example if you have reference/index.rst and guides/index.rst then in the TOC, the top level of the TOC should be Reference and Guides

We don't need it anymore.

Hi,

I understand there was a need for new modern fresh responsive design, but from functionality scope it's not well done. As first, any previous existing URLs are not working now. Anything I've had in bookmarks, or if I'm using them from any discussions redirects to Not Found page :(

Second, when I've been using your previous API docs, I used to click on functions/properties to get into code and see, how the things are done. Now I'm not able to do it. Am I missing something?

Thank you
Bye

If you click an anchor that is manually setup in a page, it breaks the auto expanding of the sidebar.

Is it possible to add translation support? For example, to translate documentation into another language? That would be great.

In the version switcher, if you are on a file that was removed from a version, don't show the link.

Example /projects/doctrine-orm/en/2.6/changelog/migration_2_5.html this does not exist in master.

The "Contribute" page is outdated and requires a partial rewrite. Here are a few things I spotted (the list is not guaranteed to be exhaustive):

• maintenance branches are not called release-*
• JIRA is not used anymore

Right now we do code highlighting client side:

• https://github.com/doctrine/doctrine-website/blob/master/source/js/main.js#L25
• https://github.com/doctrine/doctrine-website/blob/master/source/_layouts/layout.html#L23
• https://github.com/doctrine/doctrine-website/blob/master/source/_layouts/layout.html#L137

It would be best to do this server side at build time.

Could we use this? https://github.com/scrivo/highlight.php

We have a maintained: true/false property on the version now, so we need to start using it in the UI.

It needs to be located here:

• http://www.doctrine-project.org/schemas/orm/doctrine-mapping.xsd
• https://www.doctrine-project.org/schemas/odm/doctrine-mongo-mapping.xsd

Previously it looks like we had a redirect setup to this file in github:

• https://raw.githubusercontent.com/doctrine/doctrine2/master/doctrine-mapping.xsd
• https://raw.githubusercontent.com/doctrine/mongodb-odm/master/doctrine-mongo-mapping.xsd

Right now it is empty and says coming soon. Even something very basic to get started would be better than what we have now.

https://github.com/doctrine/lexer/tree/master/docs/en

• Release cycle
  • Every month we have a bug fix release.
  • Every 6 months we have a minor release.
  • Every 2 years we have a major release.
• Only maintain at most 3 branches at a time per project.
  • 1 branch for current stable release
  • 1 branch for previous stable release
  • 1 branch for master (next)
• All bug fixes should be targeted to the master branch and then cherry-picked to each branch where the bug fix applies.
  • We need some kind of tooling to automate this and ensure that all applicable bugs are cherry-picked to each branch where relevant.
• New features are merged in to the master branch.
• Trigger deprecations warnings at runtime whenever possible before the BC break is released.

Right now it is empty and says coming soon. Even something very basic to get started would be better than what we have now.

https://github.com/doctrine/cache/tree/master/docs/en

I think other sub communities exist like http://slack.laraveldoctrine.org/

Right now we are using a vm in AWS to do the builds but it would be ideal if we could use 100% travis. Someone needs to figure out how to make this work with our setup.

Add doctrine/coding-standard to this repository to enforce the Doctrine coding standards.

We are standardizing on documentation living within the repository of each project in a folder named docs. We need to migrate https://github.com/doctrine/migrations-documentation to https://github.com/doctrine/migrations

Right now it is empty and says coming soon. Even something very basic to get started would be better than what we have now.

https://github.com/doctrine/inflector/tree/master/docs/en

We need to differentiate them more and make them look better.

See examples here https://www.doctrine-project.org/example/

Code is here https://github.com/doctrine/doctrine-website-sculpin/blob/master/source/example.rst

Custom directives can be found here https://github.com/doctrine/doctrine-website-sculpin/tree/master/app/src/Doctrine/Website/DoctrineSculpinBundle/Directive

Hello and thanks for this new website 👍

Would it be possible to add a RSS feed ?

Right now if some docs have a reference to a page that doesn't exist, it just silently ignores it and leaves an empty href.

Something isn't right about it still. It is quirky and sometimes doesn't scroll the sidebar to the right place.

Document the redirect rules that need to be in place before turning on HSTS.

For example:

 :ref:`pessimistic locking <transactions_and_concurrency_pessimistic_locking>`

This works in sphinx even though the chapter file is named with hyphens instead of underscores. The parser must do some kind of check on both formats or normalization of formatting for lookups/resolution.

We're going to probably eventually want to support more versions in the UI so we should enhance this UI.

Right now we do not support the configuration block directive and the example below just renders the code examples one after another.

.. configuration-block::

    .. code-block:: php

        <?php
        /** @Entity */
        class Message
        {
            //...
        }

    .. code-block:: xml

        <doctrine-mapping>
          <entity name="Message">
              <!-- ... -->
          </entity>
        </doctrine-mapping>

Add new directives here https://github.com/doctrine/doctrine-website-sculpin/tree/master/app/src/Doctrine/Website/DoctrineSculpinBundle/Directive and wire them up in the container here https://github.com/doctrine/doctrine-website-sculpin/blob/master/app/src/Doctrine/Website/DoctrineSculpinBundle/Resources/config/services.yml

Right now it is empty and says coming soon. Even something very basic to get started would be better than what we have now.

https://github.com/doctrine/orientdb-odm/tree/master/docs/en

Once we're done getting everything the way we want it in master, backport it to the last supported version and any future branches.

After the build runs in the tests, set up something using symfony crawler to get the homepage, click a project, click docs, etc and assert things on the html.

Right now it is empty and says coming soon. Even something very basic to get started would be better than what we have now.

https://github.com/doctrine/annotations/tree/master/docs/en

Right now we have the url generation sprinkled throughout twig templates so if we ever change a url pattern, we have to change this in many places.